com.hyfinity.utils.xml

Class XDocument

java.lang.Object

com.hyfinity.utils.xml.XDocument

public class XDocument
extends java.lang.Object

This class wraps an org.w3c.dom.Document and provides some utility methods for extracting data from the class.

Version:

1.0

Author:

Hyfinity Ltd.

Constructor Summary

Constructors

Constructor and Description
XDocument() XDocument constructor.
XDocument(org.w3c.dom.Document doc) XDocument constructor.
XDocument(java.io.File file) XDocument constructor.
XDocument(java.io.InputStream is) XDocument constructor.
XDocument(org.w3c.dom.Node rootNode) XDocument constructor.
XDocument(java.lang.String xmlString) XDocument constructor.

Method Summary

Modifier and Type	Method and Description
void	addNamespace(java.lang.String prefix, java.lang.String namespaceUri) Adds the given namespace definition to this documents XPathFactory, to use when evaluating XPaths.
org.w3c.dom.Document	getDocument() Returns the DOM Document contained by this object.
org.w3c.dom.Node	getRootNode() Return the top most node of this document.
org.w3c.dom.traversal.NodeIterator	selectNodeIterator(java.lang.String xpath) Evaluates the given xpath against this document and returns a matching NodeIterator.
org.w3c.dom.NodeList	selectNodeList(java.lang.String xpath) Evaluates the given xpath against this document and returns a matching NodeList.
org.w3c.dom.Node	selectSingleNode(java.lang.String xpath) Evaluates the given xpath against this document and returns the first matching Node.
java.lang.String	selectString(java.lang.String xpath) Evaluates the given xpath against this document and returns the result as a String.
void	setDocument(org.w3c.dom.Document doc) Sets the DOM document contained by this object to the given object.
void	setNamespaces(java.util.Map namespaces) Adds all the namespaces defined in the given map to this document's xpathfactory.
java.lang.String	toString() Produce a String representation for the XML Document.
XDocument	transform(javax.xml.transform.Templates templates) Utility method to transform the current document using a provided Templates object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XDocument

public XDocument()

XDocument constructor. This initialises the object with an neew DOM Document.

XDocument

public XDocument(org.w3c.dom.Document doc)

XDocument constructor. Takes a DOM Document which this class will then wrap.

Parameters:

doc - The org.w3c.dom.Document object to be wrapped by this class

XDocument

public XDocument(org.w3c.dom.Node rootNode)

XDocument constructor. Takes a Node which this class will then wrap.

Parameters:

rootNode - The org.w3c.dom.Node object to be wrapped by this class

XDocument

public XDocument(java.lang.String xmlString)

XDocument constructor. Takes a string and converts it into a DOM document, which this class will then wrap.

Parameters:

xmlString - String representation of the document

XDocument

public XDocument(java.io.File file)

XDocument constructor. Takes a string and converts it into a DOM document, which this class will then wrap.

Parameters:

file - the File location of the document to be parsed

XDocument

public XDocument(java.io.InputStream is)

XDocument constructor. This constructor takes an InputStream, and attempts to read an XML String from it. This is then parsed to create the DOM Document.

Parameters:

is - The InputStream to read from.

Method Detail

getDocument

public final org.w3c.dom.Document getDocument()

Returns the DOM Document contained by this object.

Returns:

The DOM Document.

setDocument

public final void setDocument(org.w3c.dom.Document doc)

Sets the DOM document contained by this object to the given object.

Parameters:

doc - the new DOM Document.

getRootNode

public final org.w3c.dom.Node getRootNode()

Return the top most node of this document.

Returns:

Node.

setNamespaces

public final void setNamespaces(java.util.Map namespaces)

Adds all the namespaces defined in the given map to this document's xpathfactory. to use when evaluating XPaths against this document

Parameters:

namespaces - A map of namespace prefixes to values/

addNamespace

public final void addNamespace(java.lang.String prefix,
                               java.lang.String namespaceUri)

Adds the given namespace definition to this documents XPathFactory, to use when evaluating XPaths.

Parameters:

prefix - The prefix to use for this namespace.

namespaceUri - The actual value (namespaceURI) of this namespace.

selectString

public final java.lang.String selectString(java.lang.String xpath)

Evaluates the given xpath against this document and returns the result as a String.

Parameters:

xpath - The xpath query to evaluate.

Returns:

The String result of the XPath

selectSingleNode

public final org.w3c.dom.Node selectSingleNode(java.lang.String xpath)

Evaluates the given xpath against this document and returns the first matching Node.

Parameters:

xpath - The xpath query to evaluate.

Returns:

The first Node that matches.

selectNodeList

public final org.w3c.dom.NodeList selectNodeList(java.lang.String xpath)

Evaluates the given xpath against this document and returns a matching NodeList.

Parameters:

xpath - The xpath query to evaluate.

Returns:

A NodeList containing the matching nodes.

selectNodeIterator

public final org.w3c.dom.traversal.NodeIterator selectNodeIterator(java.lang.String xpath)

Evaluates the given xpath against this document and returns a matching NodeIterator.

Parameters:

xpath - The xpath query to evaluate.

Returns:

A NodeIterator over all teh matching nodes.

toString

public final java.lang.String toString()

Produce a String representation for the XML Document.

Overrides:

toString in class java.lang.Object

Returns:

String

transform

public final XDocument transform(javax.xml.transform.Templates templates)

Utility method to transform the current document using a provided Templates object.

Parameters:

templates - The Templates object to use for the transformation.

Returns:

A new XDocument containing the result of the transform.