Interface XPath
- All Superinterfaces:
NodeFilter
- All Known Implementing Classes:
DefaultXPath
XPath
represents an XPath expression after it has been parsed
from a String.
- Version:
- $Revision: 1.20 $
- Author:
- James Strachan
-
Method Summary
Modifier and TypeMethodDescriptionboolean
booleanValueOf
(Object context) Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context.evaluate
evaluates an XPath expression and returns the result as anObject
.org.jaxen.FunctionContext
DOCUMENT ME!org.jaxen.NamespaceContext
DOCUMENT ME!getText()
getText
will return the textual version of the XPath expression.org.jaxen.VariableContext
DOCUMENT ME!boolean
matches
returns true if the given node matches the XPath expression.numberValueOf
(Object context) numberValueOf
evaluates an XPath expression and returns the numeric value of the XPath expression if the XPath expression results is a number, or null if the result is not a number.selectNodes
(Object context) selectNodes
(Object context, XPath sortXPath) selectNodes
(Object context, XPath sortXPath, boolean distinct) selectObject
(Object context) Deprecated.please use evaluate(Object) instead.selectSingleNode
(Object context) void
setFunctionContext
(org.jaxen.FunctionContext functionContext) Sets the function context to be used when evaluating XPath expressionsvoid
setNamespaceContext
(org.jaxen.NamespaceContext namespaceContext) Sets the namespace context to be used when evaluating XPath expressionsvoid
setNamespaceURIs
(Map map) Sets the current NamespaceContext from a Map where the keys are the String namespace prefixes and the values are the namespace URIs.void
setVariableContext
(org.jaxen.VariableContext variableContext) Sets the variable context to be used when evaluating XPath expressionsvoid
sort
sorts the given List of Nodes using this XPath expression as aComparator
.void
sort
sorts the given List of Nodes using this XPath expression as aComparator
and optionally removing duplicates.valueOf
evaluates this XPath expression and returns the textual representation of the results using the XPath string() function.
-
Method Details
-
getText
String getText()getText
will return the textual version of the XPath expression.- Returns:
- the textual format of the XPath expression.
-
matches
matches
returns true if the given node matches the XPath expression. To be more precise when evaluating this XPath expression on the given node the result set must include the node.- Specified by:
matches
in interfaceNodeFilter
- Parameters:
node
- DOCUMENT ME!- Returns:
- true if the given node matches this XPath expression
-
evaluate
-
selectObject
Deprecated.please use evaluate(Object) instead. WILL BE REMOVED IN dom4j-1.6 !! -
selectNodes
selectNodes
performs this XPath expression on the givenNode
orList
ofNode
s instances appending all the results together into a single list.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath- Returns:
- the results of all the XPath evaluations as a single list
-
selectNodes
selectNodes
evaluates the XPath expression on the givenNode
orList
ofNode
s and returns the result as aList
ofNode
s sorted by the sort XPath expression.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPathsortXPath
- is the XPath expression to sort by- Returns:
- a list of
Node
instances
-
selectNodes
selectNodes
evaluates the XPath expression on the givenNode
orList
ofNode
s and returns the result as aList
ofNode
s sorted by the sort XPath expression.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPathsortXPath
- is the XPath expression to sort bydistinct
- specifies whether or not duplicate values of the sort expression are allowed. If this parameter is true then only distinct sort expressions values are included in the result- Returns:
- a list of
Node
instances
-
selectSingleNode
selectSingleNode
evaluates this XPath expression on the givenNode
orList
ofNode
s and returns the result as a singleNode
instance.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath- Returns:
- a single matching
Node
instance
-
valueOf
valueOf
evaluates this XPath expression and returns the textual representation of the results using the XPath string() function.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath- Returns:
- the string representation of the results of the XPath expression
-
numberValueOf
numberValueOf
evaluates an XPath expression and returns the numeric value of the XPath expression if the XPath expression results is a number, or null if the result is not a number.- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath- Returns:
- the numeric result of the XPath expression or null if the result is not a number.
-
booleanValueOf
Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context.The boolean-value of the expression is determined per the
boolean(..)
core function as defined in the XPath specification. This means that an expression that selects zero nodes will returnfalse
, while an expression that selects one-or-more nodes will returntrue
.- Parameters:
context
- The node, nodeset or Context object for evaluation. This value can be null- Returns:
- The boolean-value interpretation of this expression.
- Since:
- 1.5
-
sort
sort
sorts the given List of Nodes using this XPath expression as aComparator
.- Parameters:
list
- is the list of Nodes to sort
-
sort
sort
sorts the given List of Nodes using this XPath expression as aComparator
and optionally removing duplicates.- Parameters:
list
- is the list of Nodes to sortdistinct
- if true then duplicate values (using the sortXPath for comparisions) will be removed from the List
-
getFunctionContext
org.jaxen.FunctionContext getFunctionContext()DOCUMENT ME!- Returns:
- the current function context
-
setFunctionContext
void setFunctionContext(org.jaxen.FunctionContext functionContext) Sets the function context to be used when evaluating XPath expressions- Parameters:
functionContext
- DOCUMENT ME!
-
getNamespaceContext
org.jaxen.NamespaceContext getNamespaceContext()DOCUMENT ME!- Returns:
- the current namespace context
-
setNamespaceContext
void setNamespaceContext(org.jaxen.NamespaceContext namespaceContext) Sets the namespace context to be used when evaluating XPath expressions- Parameters:
namespaceContext
- DOCUMENT ME!
-
setNamespaceURIs
Sets the current NamespaceContext from a Map where the keys are the String namespace prefixes and the values are the namespace URIs.
For example:
Map uris = new HashMap(); uris.put("SOAP-ENV", "http://schemas.xmlsoap.org/soap/envelope/"); uris.put("m", "urn:xmethodsBabelFish"); XPath xpath = document .createXPath("SOAP-ENV:Envelope/SOAP-ENV:Body/m:BabelFish"); xpath.setNamespaceURIs(uris); Node babelfish = xpath.selectSingleNode(document);
- Parameters:
map
- the map containing the namespace mappings
-
getVariableContext
org.jaxen.VariableContext getVariableContext()DOCUMENT ME!- Returns:
- the current variable context
-
setVariableContext
void setVariableContext(org.jaxen.VariableContext variableContext) Sets the variable context to be used when evaluating XPath expressions- Parameters:
variableContext
- DOCUMENT ME!
-