pdk.flow.xml.XmlNode

contains functions to operate with XML Node 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!

Table 1: The values of nodeName, nodeValue, and attributes

Type
nodeName
nodeValue
attributes

Attr

same as XmlAttr.getName()

same as XmlAttr.getValue()

null

CDATASection

"#cdata-section"

same as XmlCharacterData.getData(), the content of the CDATA Section

null

Comment

"#comment"

same as XmlCharacterData.getData(), the content of the comment

null

Document

"#document"

null

null

DocumentFragment

"#document-fragment"

null

null

DocumentType

same as XmlDocumentType.getName()

null

null

Element

same as XmlElement.getTagName()

null

NamedNodeMap

Entity

entity name

null

null

EntityReference

name of entity referenced

null

null

Notation

notation name

null

null

ProcessingInstruction

same as XmlProcessingInstruction.getTarget()

same as XmlProcessingInstruction.getData()

null

Text

"#text"

same as XmlCharacterData.getData(), the content of the text node

null

Table 2: Constants

Name
Description
Value

ATTRIBUTE_NODE

The node is an Attr

2

CDATA_SECTION_NODE

The node is a CDATASection

4

COMMENT_NODE

The node is a Comment

8

DOCUMENT_FRAGMENT_NODE

The node is a DocumentFragment

11

DOCUMENT_NODE

The node is a Document

9

DOCUMENT_POSITION_CONTAINED_BY

The node is contained by the reference node. A node which is contained is always following, too

16

DOCUMENT_POSITION_CONTAINS

The node contains the reference node. A node which contains is always preceding, too

8

DOCUMENT_POSITION_DISCONNECTED

The two nodes are disconnected. Order between disconnected nodes is always implementation-specific

1

DOCUMENT_POSITION_FOLLOWING

The node follows the reference node

4

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

The determination of preceding versus following is implementation-specific

32

DOCUMENT_POSITION_PRECEDING

The second node precedes the reference node

2

DOCUMENT_TYPE_NODE

The node is a DocumentType

10

ELEMENT_NODE

The node is an Element

1

ENTITY_NODE

The node is an Entity

6

ENTITY_REFERENCE_NODE

The node is an EntityReference

5

NOTATION_NODE

The node is a Notation

12

PROCESSING_INSTRUCTION_NODE

The node is a ProcessingInstruction

7

TEXT_NODE

The node is a Text node

3

All functions

appendChild

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node or newChild is NULL

  • DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to append a second DocumentType or Element node. WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly. NOT_SUPPORTED_ERR: if the newChild node is a child of the Document node, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or Element child.

cloneNode

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode is null) and no user data. User data associated to the imported node is not carried over. Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.

Arguments:

  • node :: pdk.net.xml.Node - The node to be cloned

  • deep :: pdk.core.Boolean - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element)

Result:

Possible exceptions

compareDocumentPosition

Compares the reference node, i.e. the node passed as the first parameter, with a node, i.e. the one passed as the second parameter, with regard to their position in the document and according to the document order.

Arguments:

Result:

  • output :: pdk.core.Integer - Returns how the node is positioned relatively to the reference node

Possible exceptions

  • NullPointerException - throws if the node or other is NULL

  • DOMException - NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.

getAttributes

Returns a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Arguments:

Result:

Possible exceptions

getBaseURI

The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when the Document supports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise.

Arguments:

Result:

Possible exceptions

getChildNodes

An array of Nodes that contains all children of this node. If there are no children, then array will be empty.

Arguments:

Result:

Possible exceptions

getConstantName

Returns name of the constant by value.

Arguments:

Result:

Possible exceptions

getConstantValue

Returns value of the constant by name.

Arguments:

Result:

Possible exceptions

getFirstChild

The first child of this node. If there is no such node, this returns null.

Arguments:

Result:

Possible exceptions

getLastChild

The last child of this node. If there is no such node, this returns null.

Arguments:

Result:

Possible exceptions

getLocalName

Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as XMLDocument.createElement(), this is always null

Arguments:

Result:

Possible exceptions

getNamespaceURI

The namespace URI of this node, or null if it is unspecified (see ). This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as XMLDocument.createElement(), this is always null.

Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace

Arguments:

Result:

Possible exceptions

getNextSibling

The node immediately following this node. If there is no such node, this returns null

Arguments:

Result:

Possible exceptions

getNodeName

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node is NULL

  • DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform

getNodeType

A code representing the type of the underlying object, as defined above.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node is NULL

  • DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform

getNodeValue

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node is NULL

  • DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform

getOwnerDocument

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null

Arguments:

Result:

Possible exceptions

getParentNode

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.

Arguments:

Result:

Possible exceptions

getPrefix

The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr, when applicable. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as XmlDocument.createElement(), this is always null.

Arguments:

Result:

Possible exceptions

getPreviousSibling

The node immediately preceding this node. If there is no such node, this returns null.

Arguments:

Result:

Possible exceptions

getTextContent

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute XmlText.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content. The string returned is made of the text content of this node depending on its type, as defined below:

Node type
Content

ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE

concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE

nodeValue

DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE

null

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node is NULL

  • DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform

getUserData

Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.

Arguments:

Result:

  • output :: pdk.core.Any - Returns the DOMUserData associated to the given key on this node, or null if there was none.

Possible exceptions

hasAttributes

Returns whether this node (if it is an element) has any attributes.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if this node has any attributes, false otherwise.

Possible exceptions

hasChildNodes

Returns whether this node has any children.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if this node has any children, false otherwise.

Possible exceptions

insertBefore

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children. If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node , newChild or refChild is NULL

  • DOMException - HIERARCHY_REQUEST_ERR : Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to insert a second DocumentType or Element node. WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly. NOT_FOUND_ERR: Raised if refChild is not a child of this node. NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node.

isDefaultNamespace

This method checks if the specified namespaceURI is the default namespace or not.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if the specified namespaceURI is the default namespace, false otherwise

Possible exceptions

isEqualNode

Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with isSameNode. All nodes that are the same will also be equal, though the reverse may not be true. Two nodes are equal if and only if the following conditions are satisfied:

  • The two nodes are of the same type.

  • The following string attributes are equal: nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.

  • The attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.

  • The childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.

For two DocumentType nodes to be equal, the following conditions must also be satisfied:

  • The following string attributes are equal: publicId, systemId, internalSubset.

  • The entities NamedNodeMaps are equal.

  • The notations NamedNodeMaps are equal.

On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the XmlText.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if the nodes are equal, false otherwise

Possible exceptions

isSameNode

Returns whether this node is the same node as the given one. This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if the nodes are the same, false otherwise

Possible exceptions

isSupported

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in.

Arguments:

Result:

  • output :: pdk.core.Boolean - Returns true if the specified feature is supported on this node, false otherwise.

Possible exceptions

lookupNamespaceURI

Look up the namespace URI associated to the given prefix, starting from this node. See for details on the algorithm used by this method.

Arguments:

  • node :: pdk.net.xml.Node - The node

  • prefix :: pdk.core.String - The prefix to look for. If this parameter is null, the method will return the default namespace URI if any

Result:

  • output :: pdk.core.String - Returns the associated namespace URI or null if none is found

Possible exceptions

lookupPrefix

Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See for details on the algorithm used by this method.

Arguments:

Result:

  • output :: pdk.core.String - Returns an associated namespace prefix if found or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent

Possible exceptions

normalize

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the getOwnerDocument is true, this method will also fully normalize the characters of the Text nodes.

Arguments:

Result:

  • output :: void

Possible exceptions

removeChild

Removes the child node indicated by oldChild from the list of children, and returns it.

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node or oldChild is NULL

  • DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of this node. NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child.

replaceChild

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Replacing a node with itself is implementation dependent

Arguments:

Result:

Possible exceptions

  • NullPointerException - throws if the node , newChild or oldChild is NULL

  • DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of type Document and the result of the replacement operation would add a second DocumentType or Element on the Document node. WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of this node. NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child.

setNodeValue

The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect, including if the node is read-only.

Arguments:

Result:

  • output :: void

Possible exceptions

  • NullPointerException - throws if the node or nodeValue is NULL

  • DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be null

setPrefix

The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable. Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as XmlDocument.createElement, this is always null.

Arguments:

Result:

  • output :: void

Possible exceptions

  • NullPointerException - throws if the node or namespaceURI is NULL

  • DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in the XmlDocument.getXmlVersion. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" [XML Namespaces] .

setTextContent

This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute XmlText.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content. The string returned is made of the text content of this node depending on its type, as defined below:

Node type
Content

ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE

concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children

TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE

nodeValue

DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE

null

Arguments:

Result:

  • output :: void

Possible exceptions

setUserData

Not Implemented.

Previouspdk.flow.xml.XmlElementNextpdk.flow.xml.XmlDocument

Last updated