xml.DomNode methods

Methods for the xml.DomNode class.

Table 1. Object methods: Navigation
Name Description
getParentNode()
  RETURNING object xml.DomNode
Returns the parent DomNode object for this DomNode object.
getFirstChild()
  RETURNING object xml.DomNode
Returns the first child DomNode object for this XML Element DomNode object.
getFirstChildElement()
  RETURNING object xml.DomNode
Returns the first XML Element child DomNode object for this DomNode object.
getLastChild()
  RETURNING object xml.DomNode
Returns the last child DomNode object for a XML Element DomNode object.
getLastChildElement()
  RETURNING object xml.DomNode
Returns the last child XML element DomNode object for this DomNode object.
getNextSibling()
  RETURNING object xml.DomNode
Returns the DomNode object immediately following a DomNode object.
getNextSiblingElement()
  RETURNING object xml.DomNode
Returns the XML Element DomNode object immediately following a DomNode object.
getPreviousSibling()
  RETURNING object xml.DomNode
Returns the DomNode object immediately preceding a DomNode object.
getPreviousSiblingElement()
  RETURNING object xml.DomNode
Returns the XML Element DomNode object immediately preceding a DomNode object.
getOwnerDocument()
  RETURNING object xml.DomDocument
Returns the DomDocument object containing this DomNode object.
hasChildNodes()
  RETURNING flag INTEGER
Returns TRUE if a node has child nodes.
getChildrenCount()
  RETURNING cnt INTEGER
Returns the number of child DomNode objects for a DomNode object.
getChildNodeItem(
   pos INTEGER )
  RETURNING object xml.DomNode
Returns the child DomNode object at a given position for a DomNode object.
Table 2. Object methods: Manipulation
Name Description
prependChildElement(
   name STRING )
  RETURNING object xml.DomNode
Creates and adds a child XML Element node to the beginning of the list of child nodes for this XML Element DomNode object.
prependChildElementNS(
   prefix STRING,
   name STRING,
   ns STRING )
  RETURNING object xml.DomNode
Creates and adds a child namespace-qualified XML Element node to the beginning of the list of child nodes for an XML Element DomNode object.
addPreviousSibling(
   node xml.DomNode )
Adds a DomNode object as the previous sibling of a DomNode object.
addNextSibling(
  node xml.DomNode )
Adds a DomNode object as the next sibling of a DomNode object.
prependChild(
   node xml.DomNode )
Adds a child DomNode object to the beginning of the child list for a DomNode object.
appendChild(
  node xml.DomNode )
Adds a child DomNode object to the end of the child list for a DomNode object
insertBeforeChild(
   node xml.DomNode,
   ref xml.DomNode )
Inserts a DomNode object before an existing child DomNode object.
insertAfterChild(
   node xml.DomNode,
   ref xml.DomNode )
Inserts a DomNode object after an existing child DomNode object.
removeChild(
   node xml.DomNode )  
Removes a child DomNode object from the list of child DomNode objects.
removeAllChildren()
Removes all child DomNode objects from a DomNode object.
replaceChild(
   new xml.DomNode,
   old xml.DomNode )
Replaces an existing child DomNode with another child DomNode object.
appendChildElement(
   name STRING )
  RETURNING object xml.DomNode
Creates and adds a child XML Element node to the end of the list of child nodes for an XML Element DomNode object.
appendChildElementNS(
   prefix STRING,
   name STRING,
   ns STRING )
  RETURNING object xml.DomNode
Creates and adds a child namespace qualified XML Element node to the end of the list of child nodes for an XML Element DomNode object.
clone(
   deep INTEGER )
  RETURNING object xml.DomNode
Returns a duplicate DomNode object of a node.
Table 3. Object methods: Access
Name Description
getNodeType()
  RETURNING str STRING
Gets the XML type for this DomNode object.
getLocalName()
  RETURNING str STRING
Gets the local name for a DomNode object.
getNodeName()
  RETURNING str STRING
Gets the name for a DomNode object.
getNamespaceURI()
  RETURNING str STRING
Returns the namespace URI for a DomNode object.
getNodeValue()
  RETURNING str STRING 
Returns the value for a DomNode object.
getPrefix()
  RETURNING str STRING 
Returns the prefix for a DomNode object.
isAttached()
  RETURNING num INTEGER
Returns whether the node is attached to the XML document.
Table 4. Object methods: Modifier
Name Description
setNodeValue(
   val STRING )
Sets the node value for a DomNode object.
setPrefix(
  prefix STRING )
Sets the prefix for a DomNode object.
toString()
  RETURNING STRING
Returns a string representation of a DomNode object.
Table 5. Object methods: Attribute
Name Description
hasAttribute(
   name STRING )
  RETURNING flag INTEGER 
Checks whether an XML Element DomNode object has the XML Attribute specified by a specified name.
hasAttributeNS(
   name STRING,
   ns STRING )
  RETURNING flag INTEGER 
Checks whether a namespace qualified XML Attribute of a given name is carried by an XML Element DomNode object.
getAttributeNode(
   name STRING )
  RETURNING object xml.DomNode
Returns an XML Attribute DomNode object for an XML Element DomNode object
getAttributeNodeNS(
   name STRING,
   ns STRING )
  RETURNING object xml.DomNode
Returns a namespace-qualified XML Attribute DomNode object for an XML Element DomNode object
setAttributeNode(
   node xml.DomNode )
Sets (or resets) an XML Attribute DomNode object to an XML Element DomNode object.
setAttributeNodeNS(
   node xml.DomNode )
Sets (or resets) a namespace-qualified XML Attribute DomNode object to an XML Element DomNode object.
getAttribute(
   name STRING )
  RETURNING value STRING
Returns the value of an XML Attribute for an XML Element DomNode object
getAttributeNS(
   name STRING,
   ns STRING )
  RETURNING value STRING
Returns the value of a namespace qualified XML Attribute for an XML Element DomNode object
setAttribute(
   name STRING,
   value STRING )
Sets (or resets) an XML Attribute for an XML Element DomNode object.
setAttributeNS(
   prefix STRING,
   name STRING,
   ns STRING,
   value STRING )
Sets (or resets) a namespace-qualified XML Attribute for an XML Element DomNode object.
setIdAttribute(
   name STRING,
   isId INTEGER )
Declare (or undeclare) the XML Attribute of given name to be of type ID.
setIdAttributeNS(
   name STRING,
   ns STRING,
   isId INTEGER )
Declare (or undeclare) the namespace-qualified XML Attribute of given name and namespace to be of type ID.
removeAttribute(
  name STRING )
Removes an XML Attribute for an XML Element DomNode object.
removeAttributeNS(
   name STRING,
   ns STRING )
Removes a namespace qualified XML Attribute for an XML Element DomNode object
hasAttributes()
  RETURNING flag INTEGER
Identifies whether a node has XML Attribute nodes.
getAttributesCount()
  RETURNING num INTEGER
Returns the number of XML Attribute DomNode objects on this XML Element DomNode object.
getAttributeNodeItem(
   pos INTEGER )
  RETURNING object xml.DomNode
Returns the XML Attribute DomNode object at a given position on this XML Element DomNode object.
Table 6. Object methods: Search
Name Description
selectByXPath(
   expr STRING,
   NamespacesList ...)
  RETURNING list xml.DomNodeList
Returns a DomNodeList object containing all DomNode objects matching an XPath 1.0 expression.
getElementsByTagName(
   name STRING )
  RETURNING list xml.DomNodeList
Returns a DomNodeList object containing all XML Element DomNode objects with the same tag name.
getElementsByTagNameNS(
   name STRING,
   ns STRING )
  RETURNING list xml.DomNodeList
Returns a DomNodeList object containing all namespace-qualified XML Element DomNode objects with the same tag name and namespace.
isDefaultNamespace(
   ns STRING )
  RETURNING flag INTEGER
Checks whether the specified namespace URI is the default namespace.
lookupNamespaceURI(
   prefix STRING )
  RETURNING ns STRING 
Looks up the namespace URI associated to a prefix, starting from a specified node.
lookupPrefix(
   ns STRING )
  RETURNING prefix STRING
Looks up the prefix associated to a namespace URI, starting from the specified node.