Package ddf.util

Class XPathHelper

java.lang.Object

ddf.util.XPathHelper

public class XPathHelper
extends Object

Author:

Ashraf Barakat, rodgersh

Constructor Summary

Constructors

Constructor	Description
XPathHelper()
XPathHelper(String xmlText)
XPathHelper(Document document)
XPathHelper(Document document, boolean cloneAndNormalize)

Method Summary

Modifier and Type	Method	Description
String	evaluate(String xpathExpressionKey)	Convenience method for evaluating xpath expressions that uses as default for its NamespaceContext, the NamespaceResolver class
String	evaluate(String xpathExpressionKey, NamespaceContext nsContext)
Object	evaluate(String xpathExpressionKey, QName returnType)	Convenience method for evaluating xpaths that uses as default for its NamespaceContext, the NamespaceResolver class.
Object	evaluate(String xpathExpressionKey, QName returnType, NamespaceContext nsContext)
Document	getDocument()	Retrieve the XML document being worked on by this XPathHelper utility class.
String	print(String xmlDeclaration, String indent)
static String	print(Node n)	Prints a given node as a String.
static String	print(Node n, String encoding)	Prints a given node as a String
static String	xmlToString(Node node)	Convert an XML Node to a string representation.

Methods inherited from class java.lang.Object

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

Constructor Details

XPathHelper

public XPathHelper()

XPathHelper

public XPathHelper(Document document)
            throws ParserConfigurationException,
IOException,
SAXException

Parameters:

document - - To parse

Throws:

ParserConfigurationException

IOException

SAXException

XPathHelper

public XPathHelper(Document document,
 boolean cloneAndNormalize)

XPathHelper

public XPathHelper(String xmlText)
            throws ParserConfigurationException,
IOException,
SAXException

Parameters:

xmlText -

Throws:

ParserConfigurationException

IOException

SAXException

Method Details

print

public static String print(Node n)

Prints a given node as a String. This is a convenience method that uses the default character encoding.

Parameters:

n - - the node to print as a String

Returns:

the Node as a String, null if an exception is thrown or null is passed in.

print

public static String print(Node n,
 String encoding)

Prints a given node as a String

Parameters:

n - - the node to print as a String

encoding - - the character encoding to use for the returned String

Returns:

the Node as a String, null if an exception is thrown or null is passed in.

xmlToString

public static String xmlToString(Node node)

Convert an XML Node to a string representation.

Parameters:

node - the XML node to be converted

Returns:

the string representation of the XML node

evaluate

public String evaluate(String xpathExpressionKey)
                throws XPathExpressionException

Convenience method for evaluating xpath expressions that uses as default for its NamespaceContext, the NamespaceResolver class

Parameters:

xpathExpressionKey -

Returns:

a String of the matched xpath evaluation

Throws:

XPathExpressionException

evaluate

public String evaluate(String xpathExpressionKey,
 NamespaceContext nsContext)
                throws XPathExpressionException

Parameters:

xpathExpressionKey -

nsContext -

Returns:

Throws:

XPathExpressionException

evaluate

public Object evaluate(String xpathExpressionKey,
 QName returnType)
                throws XPathExpressionException

Convenience method for evaluating xpaths that uses as default for its NamespaceContext, the NamespaceResolver class. Allows you to also change the how the type is returned.

Parameters:

xpathExpressionKey -

returnType -

Throws:

XPathExpressionException

evaluate

public Object evaluate(String xpathExpressionKey,
 QName returnType,
 NamespaceContext nsContext)
                throws XPathExpressionException

Parameters:

xpathExpressionKey -

returnType -

nsContext -

Returns:

Throws:

XPathExpressionException

print

public String print(String xmlDeclaration,
 String indent)

Parameters:

xmlDeclaration -

indent -

Returns:

getDocument

public Document getDocument()

Retrieve the XML document being worked on by this XPathHelper utility class.

Returns:

the XML document