com.ausregistry.jtoolkit2.xml

Class XMLDocument

java.lang.Object

com.ausregistry.jtoolkit2.xml.XMLDocument

public class XMLDocument
extends java.lang.Object

The purpose of an XMLDocument is to provide a simple xpath evaluation interface for extracting node values from an XML document. Where the names of elements are known in advance, non DOM-specific methods should be used in order to reduce the dependency of client classes on the DOM interface.

Constructor Summary

Constructors

Constructor and Description
XMLDocument(org.w3c.dom.Element root) Create an XMLDocument rooted at the given element.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getChildNames(java.lang.String query) Get the names of all the nodes which are children of the node identified by the given XPath expression.
org.w3c.dom.Node	getElement(java.lang.String query) Get the Node identified by the given XPath expression.
org.w3c.dom.NodeList	getElements(java.lang.String query) Get the node set identified by the given XPath expression.
int	getNodeCount(java.lang.String query) Get the number of nodes returned by the given xpath expression.
java.lang.String	getNodeName(java.lang.String query) Get as a String the name of the node identified by the given XPath expression.
java.lang.String	getNodeValue(java.lang.String query) Get as a String the text content of a node identified by the given XPath expression.
java.lang.String[]	getNodeValues(java.lang.String query) Get the text content of each node identified by the given XPath expression.
java.lang.String	getSourceXMLString() Returns the XML used to produce the document.
java.lang.String	toString() Use an XMLWriter to serialize to XML form the DOM tree associated with this XMLDocument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLDocument

public XMLDocument(org.w3c.dom.Element root)

Create an XMLDocument rooted at the given element.

Parameters:

root - The root element of the XML document.

Method Detail

getSourceXMLString

public java.lang.String getSourceXMLString()

Returns the XML used to produce the document.

Returns:

the XML

toString

public java.lang.String toString()

Use an XMLWriter to serialize to XML form the DOM tree associated with this XMLDocument.

Overrides:

toString in class java.lang.Object

Returns:

the string representation the document

getNodeCount

public int getNodeCount(java.lang.String query)
                 throws javax.xml.xpath.XPathExpressionException

Get the number of nodes returned by the given xpath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The number of nodes.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getNodeValue

public java.lang.String getNodeValue(java.lang.String query)
                              throws javax.xml.xpath.XPathExpressionException

Get as a String the text content of a node identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The text content of the identified node.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getNodeName

public java.lang.String getNodeName(java.lang.String query)
                             throws javax.xml.xpath.XPathExpressionException

Get as a String the name of the node identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The name of the identified node.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getChildNames

public java.lang.String[] getChildNames(java.lang.String query)
                                 throws javax.xml.xpath.XPathExpressionException

Get the names of all the nodes which are children of the node identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The names of all the children nodes.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getNodeValues

public java.lang.String[] getNodeValues(java.lang.String query)
                                 throws javax.xml.xpath.XPathExpressionException

Get the text content of each node identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

An array of each identified node's text content.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getElements

public org.w3c.dom.NodeList getElements(java.lang.String query)
                                 throws javax.xml.xpath.XPathExpressionException

Get the node set identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The set of nodes identified by the given expression.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception

getElement

public org.w3c.dom.Node getElement(java.lang.String query)
                            throws javax.xml.xpath.XPathExpressionException

Get the Node identified by the given XPath expression.

Parameters:

query - The XPath expression to evaluate.

Returns:

The identified Node.

Throws:

javax.xml.xpath.XPathExpressionException - the XPath expression exception