Package org.jdesktop.xpath

Class XPathUtils

java.lang.Object

org.jdesktop.xpath.XPathUtils

public class XPathUtils
extends Object

Various utilities for working with XPath. This class uses a static XPath object for most of it's work. This XPath object is preconfigured to use the extended XPath functions of the org.jdesktop.xpath.function package.

Method Summary

Modifier and Type	Method	Description
static XPathExpression	compile(String expression)	Compiles the given expression, using the internal XPath instance of this class and returns the XPathExpression.
static Node	getElement(String expression, Node node)	Returns a Node matching the given expression.
static Node	getElement(XPathExpression expression, Node node)	Returns a Node matching the given expression.
static SimpleNodeList	getElements(String expression, Node node)	Returns a SimpleNodeList containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).
static SimpleNodeList	getElements(XPathExpression expression, Node node)	Returns a SimpleNodeList containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).
static String	getString(String expression, Node node)	Returns the text content of the Node matching the given expression.
static String	getString(String expression, Node node, String namespace, String namespacePrefix)
static String	getString(XPathExpression expression, Node node)	Returns the text content of the Node matching the given expression.
static String	toXML(Document dom)	Exports this DOM as a String
static String	toXML(Document dom, Properties outputProperties)

Methods inherited from class java.lang.Object

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

Method Details

getElements

public static SimpleNodeList getElements(String expression,
 Node node)
                                  throws XPathExpressionException

Returns a SimpleNodeList containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

SimpleNodeList containing the results from the expression. This will never be null, but may contain no results.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

getElement

public static Node getElement(String expression,
 Node node)
                       throws XPathExpressionException

Returns a Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

Node. May be null.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

getString

public static String getString(String expression,
 Node node)
                        throws XPathExpressionException

Returns the text content of the Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

text content of the selected Node. May be null.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

getString

public static String getString(String expression,
 Node node,
 String namespace,
 String namespacePrefix)
                        throws XPathExpressionException

Throws:

XPathExpressionException

getElements

public static SimpleNodeList getElements(XPathExpression expression,
 Node node)
                                  throws XPathExpressionException

Returns a SimpleNodeList containing all the nodes that match the given expression when executed on the given node (as opposed to the dom as a whole).

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

SimpleNodeList containing the results from the expression. This will never be null, but may contain no results.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

getElement

public static Node getElement(XPathExpression expression,
 Node node)
                       throws XPathExpressionException

Returns a Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

Node. May be null.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

getString

public static String getString(XPathExpression expression,
 Node node)
                        throws XPathExpressionException

Returns the text content of the Node matching the given expression. If more than one node matches, the return value is undefined.

Parameters:

expression - an XPath expression

node - the contextual node

Returns:

text content of the selected Node. May be null.

Throws:

IllegalArgumentException - if the expression does not parse

XPathExpressionException

compile

public static XPathExpression compile(String expression)
                               throws XPathExpressionException

Compiles the given expression, using the internal XPath instance of this class and returns the XPathExpression.

Parameters:

expression - The XPath expression to compile

Returns:

the compiled XPathExpression

Throws:

XPathExpressionException - for a malformed XPath expression

toXML

public static String toXML(Document dom)

Exports this DOM as a String

toXML

public static String toXML(Document dom,
 Properties outputProperties)