XmlNode

Overview

XML nodes are structured elements that support interaction and manipulation through various methods. These methods facilitate operations such as retrieving attribute names and values, accessing child nodes, obtaining the node name and type, and fetching the text value of an XML node.

Functionality

The getAttributeNames method retrieves all attribute names from the current node, while getAttributeValue returns the value of a specified attribute. To interact with node relationships, getChildNodes allows access to all child nodes. Additionally, getName provides the name of the XML node, and getType identifies its type. For textual data, getTextValue extracts the text content of the node.

Methods Summarized

Type	Name	Summary
Array	getAttributeNames()	Return all the attribute names of the current node.
String	getAttributeValue(attributeName)	Return the value of the named attribute.
Array	getChildNodes()	Return the child nodes of the current node.
String	getName()	Return the name of the XML node element.
String	getTextValue()	Return the text-value of the XML node element.
String	getType()	Return the type of the XML node element.

Methods Detailed

getAttributeNames()

Return all the attribute names of the current node.

Returns: Array an array of attribute names for the current XML node, or an empty array if the node has no attributes.

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString("<root attr1='value1' attr2='value2'/>")
rootNode = nodes[0];
attributes = rootNode.getAttributeNames();
application.output(attributes[0])
application.output(attributes[1])
val1 = rootNode.getAttributeValue('attr1');
application.output(val1)

getAttributeValue(attributeName)

Return the value of the named attribute.

Parameters

• String attributeName ;

Returns: String the value of the specified attribute, or null if the attribute does not exist.

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString("<root attr1='value1' attr2='value2'/>")
rootNode = nodes[0];
attributes = rootNode.getAttributeNames();
application.output(attributes[0])
application.output(attributes[1])
val1 = rootNode.getAttributeValue('attr1');
application.output(val1)

getChildNodes()

Return the child nodes of the current node.

Returns: Array an array of XmlNode objects representing the child nodes of the current XML node, or an empty array if there are no child nodes.

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString('<father><child1>John</child1><child2>Mary</child2></father>');
application.output(nodes[0].getName())
application.output(nodes[0].getTextValue())
application.output(nodes[0].getType())
childs = nodes[0].getChildNodes()
application.output(childs[0].getName())
application.output(childs[0].getTextValue())
application.output(childs[0].getType())
subChilds = childs[0].getChildNodes()
application.output(subChilds[0].getName())
application.output(subChilds[0].getTextValue())
application.output(subChilds[0].getType())

getName()

Return the name of the XML node element.

Returns: String the name of the XML node element.

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString('<father><child1>John</child1><child2>Mary</child2></father>');
application.output(nodes[0].getName())
application.output(nodes[0].getTextValue())
application.output(nodes[0].getType())
childs = nodes[0].getChildNodes()
application.output(childs[0].getName())
application.output(childs[0].getTextValue())
application.output(childs[0].getType())
subChilds = childs[0].getChildNodes()
application.output(subChilds[0].getName())
application.output(subChilds[0].getTextValue())
application.output(subChilds[0].getType())

getTextValue()

Return the text-value of the XML node element.

Returns: String the text value of the XML node element, or null if the node has no text content.

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString('<father><child1>John</child1><child2>Mary</child2></father>');
application.output(nodes[0].getName())
application.output(nodes[0].getTextValue())
application.output(nodes[0].getType())
childs = nodes[0].getChildNodes()
application.output(childs[0].getName())
application.output(childs[0].getTextValue())
application.output(childs[0].getType())
subChilds = childs[0].getChildNodes()
application.output(subChilds[0].getName())
application.output(subChilds[0].getTextValue())
application.output(subChilds[0].getType())

getType()

Return the type of the XML node element.

Returns: String the type of the XML node element, which can be "TEXT", "ELEMENT", or "UNKNOWN".

Sample

nodes = plugins.XmlReader.readXmlDocumentFromString('<father><child1>John</child1><child2>Mary</child2></father>');
application.output(nodes[0].getName())
application.output(nodes[0].getTextValue())
application.output(nodes[0].getType())
childs = nodes[0].getChildNodes()
application.output(childs[0].getName())
application.output(childs[0].getTextValue())
application.output(childs[0].getType())
subChilds = childs[0].getChildNodes()
application.output(subChilds[0].getName())
application.output(subChilds[0].getTextValue())
application.output(subChilds[0].getType())

---