public interface XPath extends NodeFilter
XPath
represents an XPath expression after
it has been parsed from a String.
Modifier and Type | Method and Description |
---|---|
Object |
evaluate(Object context)
evaluate evaluates an XPath expression and returns
the result as an Object . |
org.jaxen.FunctionContext |
getFunctionContext() |
org.jaxen.NamespaceContext |
getNamespaceContext() |
String |
getText()
getText will return the textual version of
the XPath expression. |
org.jaxen.VariableContext |
getVariableContext() |
boolean |
matches(Node node)
matches returns true if the given node matches
the XPath expression. |
Number |
numberValueOf(Object context)
numberValueOf evaluates an XPath expression
and returns the numeric value of the XPath expression if the XPath
expression results in a number, or null if the result is not a number. |
List |
selectNodes(Object context)
|
List |
selectNodes(Object context,
XPath sortXPath)
|
List |
selectNodes(Object context,
XPath sortXPath,
boolean distinct)
|
Object |
selectObject(Object context)
Deprecated.
please use evaluate(Object) instead.
|
Node |
selectSingleNode(Object context)
|
void |
setFunctionContext(org.jaxen.FunctionContext functionContext)
Sets the function context to be used when evaluating XPath
expressions
|
void |
setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
Sets the namespace context to be used when evaluating XPath
expressions
|
void |
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 For example.
|
void |
setVariableContext(org.jaxen.VariableContext variableContext)
Sets the variable context to be used when evaluating XPath
expressions
|
void |
sort(List list)
sort sorts the given List of Nodes
using this XPath expression as a Comparator . |
void |
sort(List list,
boolean distinct)
sort sorts the given List of Nodes
using this XPath expression as a Comparator
and optionally removing duplicates. |
String |
valueOf(Object context)
valueOf evaluates this XPath expression
and returns the textual representation of the results using the
XPath string() function. |
String getText()
getText
will return the textual version of
the XPath expression.
boolean matches(Node node)
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.
matches
in interface NodeFilter
Object selectObject(Object context)
List selectNodes(Object context)
selectNodes
performs this XPath expression
on the given Node
or List
of Node
s
instances appending all the results together into a single list.
context
- is either a node or a list of nodes on which to
evalute the XPathList selectNodes(Object context, XPath sortXPath)
selectNodes
evaluates the XPath expression
on the given Node
or List
of Node
s
and returns the result as a List
of
Node
s sorted by the sort XPath expression.
context
- is either a node or a list of nodes on which to
evalute the XPathsortXPath
- is the XPath expression to sort byNode
instancesList selectNodes(Object context, XPath sortXPath, boolean distinct)
selectNodes
evaluates the XPath expression
on the given Node
or List
of Node
s
and returns the result as a List
of
Node
s sorted by the sort XPath expression.
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 resultNode
instancesNode selectSingleNode(Object context)
selectSingleNode
evaluates this XPath expression
on the given Node
or List
of Node
s
and returns the result as a single Node
instance.
context
- is either a node or a list of nodes on which to
evalute the XPathNode
instanceString valueOf(Object context)
valueOf
evaluates this XPath expression
and returns the textual representation of the results using the
XPath string() function.
context
- is either a node or a list of nodes on which to
evalute the XPathNumber numberValueOf(Object context)
numberValueOf
evaluates an XPath expression
and returns the numeric value of the XPath expression if the XPath
expression results in a number, or null if the result is not a number.
context
- is either a node or a list of nodes on which to
evalute the XPathvoid sort(List list)
sort
sorts the given List of Nodes
using this XPath expression as a Comparator
.
list
- is the list of Nodes to sortvoid sort(List list, boolean distinct)
sort
sorts the given List of Nodes
using this XPath expression as a Comparator
and optionally removing duplicates.
list
- is the list of Nodes to sortdistinct
- if true then duplicate values (using the sortXPath for
comparisions) will be removed from the Listorg.jaxen.FunctionContext getFunctionContext()
void setFunctionContext(org.jaxen.FunctionContext functionContext)
org.jaxen.NamespaceContext getNamespaceContext()
void setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
void setNamespaceURIs(Map map)
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 );
org.jaxen.VariableContext getVariableContext()
void setVariableContext(org.jaxen.VariableContext variableContext)
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses