pdk.flow.xml.XmlNamedNodeMap

contains functions to operate with XML NamedNodeMap variables

This functions are based on Java org.w3c.dom package classes.

https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/package-summary.html

You can always rely on Java documentation and examples!

All functions

• getLength

• getNamedItem

• getNamedItemNS

• item

• removeNamedItem

• removeNamedItemNS

• setNamedItem

• setNamedItemNS

---

getLength

The number of nodes in this map. The range of valid child node indices is 0 to length-1 inclusive.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map

Result:

• output :: pdk.core.Integer

Possible exceptions

• NullPointerException - throws if the map is NULL

---

getNamedItem

Retrieves a node specified by name.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• name :: pdk.core.String - The nodeName of a node to retrieve

Result:

• output :: pdk.net.xml.Node - A Node (of any type) with the specified nodeName, or null if it does not identify any node in this map

Possible exceptions

• NullPointerException - throws if the map or name is NULL

---

getNamedItemNS

Retrieves a node specified by local name and namespace URI. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• namespaceURI :: pdk.core.String - The namespace URI of the node to retrieve
• localName :: pdk.core.String - The local name of the node to retrieve

Result:

• output :: pdk.net.xml.Node - A Node (of any type) with the specified local name and namespace URI, or null if they do not identify any node in this map.

Possible exceptions

• NullPointerException - throws if the map , namespaceURI or localName is NULL
• DOMException - NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

---

item

Returns the indexth item in the map. If index is greater than or equal to the number of nodes in this map, this returns null

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• index :: pdk.core.Integer - Index into this map

Result:

• output :: pdk.net.xml.Node - The node at the indexth position in the map, or null if that is not a valid index.

Possible exceptions

• NullPointerException - throws if the map or index is NULL

---

removeNamedItem

Removes a node specified by name. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• name :: pdk.core.String - The nodeName of the node to remove

Result:

• output :: pdk.net.xml.Node - The node removed from this map if a node with such a name exists

Possible exceptions

• NullPointerException - throws if the map or name is NULL
• DOMException - NOT_FOUND_ERR: Raised if there is no node named name in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

---

removeNamedItemNS

Removes a node specified by local name and namespace URI. A removed attribute may be known to have a default value when this map contains the attributes attached to an element, as returned by the attributes attribute of the Node interface. If so, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• namespaceURI :: pdk.core.String - The namespace URI of the node to remove
• localName :: pdk.core.String - The local name of the node to remove

Result:

• output :: pdk.net.xml.Node - The node removed from this map if a node with such a local name and namespace URI exists.

Possible exceptions

• NullPointerException - throws if the map , namespaceURI or localName is NULL
• DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

---

setNamedItem

Adds a node using its nodeName attribute. If a node with that name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect. As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• arg :: pdk.net.xml.Node - A node to store in this map. The node will later be accessible using the value of its nodeName attribute

Result:

• output :: pdk.net.xml.Node - If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.

Possible exceptions

• NullPointerException - throws if the map , namespaceURI or localName is NULL
• DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.

---

setNamedItemNS

Adds a node using its namespaceURI and localName. If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Arguments:

• map :: pdk.net.xml.NamedNodeMap - The map
• arg :: pdk.net.xml.Node - A node to store in this map. The node will later be accessible using the value of its namespaceURI and localName attributes.

Result:

• output :: pdk.net.xml.Node - If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.

Possible exceptions

• NullPointerException - throws if the map , namespaceURI or localName is NULL
• DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

---