com.collaxa.xml
Class XPathUtils

java.lang.Object
com.collaxa.xml.XPathUtils

public class XPathUtils

extends java.lang.Object

Collection of XPath expression utility methods.

Since:

2.0

Constructor Summary

XPathUtils()

Method Summary

static boolean	booleanValueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative booleanValueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.
static boolean	booleanValueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the boolean value of the XPath expression if the expression results in a boolean.
static java.lang.Object	evaluate(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative evaluate() method which takes the prefix-namespace map, this method will be removed in next release or so.
static java.lang.Object	evaluate(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the result as an java.lang.Object.
static java.lang.Number	numberValueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative numberValueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.
static java.lang.Number	numberValueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the numeric value of the XPath expression if the expression results in a number, or null if the result is not a number.
static java.util.List	selectNodes(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative selectNodes() method which takes the prefix-namespace map, this method will be removed in next release or so.
static java.util.List	selectNodes(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the result as a List of org.w3c.dom.Node instances or String instances depending on the XPath expression.
static java.lang.Object	selectSingleNode(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative selectSingleNode() method which takes the prefix-namespace map, this method will be removed in next release or so.
static java.lang.Object	selectSingleNode(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the result as a single org.w3c.dom.Node instance.
static java.lang.String	valueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression) Deprecated. Please use the other alternative valueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.
static java.lang.String	valueOf(org.w3c.dom.Element pElement, java.lang.String xpathExpression, java.util.Map prefixNamespaceMapping) Evaluates an XPath expression and returns the textual representation of the results the string-value of the node.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathUtils

public XPathUtils()

Method Detail

selectNodes

public static java.util.List selectNodes(org.w3c.dom.Element pElement,
                                         java.lang.String xpathExpression)
                                  throws java.lang.Exception

Deprecated. Please use the other alternative selectNodes() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the result as a List of org.w3c.dom.Node instances or String instances depending on the XPath expression.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

selectNodes

public static java.util.List selectNodes(org.w3c.dom.Element pElement,
                                         java.lang.String xpathExpression,
                                         java.util.Map prefixNamespaceMapping)
                                  throws java.lang.Exception

Evaluates an XPath expression and returns the result as a List of org.w3c.dom.Node instances or String instances depending on the XPath expression.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

evaluate

public static java.lang.Object evaluate(org.w3c.dom.Element pElement,
                                        java.lang.String xpathExpression)
                                 throws java.lang.Exception

Deprecated. Please use the other alternative evaluate() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the result as an java.lang.Object. The object returned can either be a java.util.List of one or more org.w3c.dom.Node instances or a scalar object like a java.lang.String or a java.lang.Number instance depending on the XPath expression.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

evaluate

public static java.lang.Object evaluate(org.w3c.dom.Element pElement,
                                        java.lang.String xpathExpression,
                                        java.util.Map prefixNamespaceMapping)
                                 throws JaxenException

Evaluates an XPath expression and returns the result as an java.lang.Object. The object returned can either be a java.util.List of one or more org.w3c.dom.Node instances or a scalar object like a java.lang.String or a java.lang.Number instance depending on the XPath expression.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

JaxenException

selectSingleNode

public static java.lang.Object selectSingleNode(org.w3c.dom.Element pElement,
                                                java.lang.String xpathExpression)
                                         throws java.lang.Exception

Deprecated. Please use the other alternative selectSingleNode() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the result as a single org.w3c.dom.Node instance.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

selectSingleNode

public static java.lang.Object selectSingleNode(org.w3c.dom.Element pElement,
                                                java.lang.String xpathExpression,
                                                java.util.Map prefixNamespaceMapping)
                                         throws java.lang.Exception

Evaluates an XPath expression and returns the result as a single org.w3c.dom.Node instance.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

valueOf

public static java.lang.String valueOf(org.w3c.dom.Element pElement,
                                       java.lang.String xpathExpression)
                                throws java.lang.Exception

Deprecated. Please use the other alternative valueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the textual representation of the results the string-value of the node.

The string-value for a given node type is defined in the XPath specification.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

valueOf

public static java.lang.String valueOf(org.w3c.dom.Element pElement,
                                       java.lang.String xpathExpression,
                                       java.util.Map prefixNamespaceMapping)
                                throws java.lang.Exception

Evaluates an XPath expression and returns the textual representation of the results the string-value of the node.

The string-value for a given node type is defined in the XPath specification.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

numberValueOf

public static java.lang.Number numberValueOf(org.w3c.dom.Element pElement,
                                             java.lang.String xpathExpression)
                                      throws java.lang.Exception

Deprecated. Please use the other alternative numberValueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the numeric value of the XPath expression if the expression results in a number, or null if the result is not a number.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

numberValueOf

public static java.lang.Number numberValueOf(org.w3c.dom.Element pElement,
                                             java.lang.String xpathExpression,
                                             java.util.Map prefixNamespaceMapping)
                                      throws java.lang.Exception

Evaluates an XPath expression and returns the numeric value of the XPath expression if the expression results in a number, or null if the result is not a number.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

booleanValueOf

public static boolean booleanValueOf(org.w3c.dom.Element pElement,
                                     java.lang.String xpathExpression)
                              throws java.lang.Exception

Deprecated. Please use the other alternative booleanValueOf() method which takes the prefix-namespace map, this method will be removed in next release or so.

Evaluates an XPath expression and returns the boolean value of the XPath expression if the expression results in a boolean.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.

booleanValueOf

public static boolean booleanValueOf(org.w3c.dom.Element pElement,
                                     java.lang.String xpathExpression,
                                     java.util.Map prefixNamespaceMapping)
                              throws java.lang.Exception

Evaluates an XPath expression and returns the boolean value of the XPath expression if the expression results in a boolean.

Parameters:

xpathExpression - is the XPath expression to be evaluated

Throws:

java.lang.Exception - if the XPath expression is invalid.