|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XPath
XPath
represents an XPath expression after it has been parsed
from a String.
Method Summary | |
---|---|
boolean |
booleanValueOf(java.lang.Object context)
Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context. |
java.lang.Object |
evaluate(java.lang.Object context)
evaluate evaluates an XPath expression and returns the
result as an Object . |
org.jaxen.FunctionContext |
getFunctionContext()
DOCUMENT ME! |
org.jaxen.NamespaceContext |
getNamespaceContext()
DOCUMENT ME! |
java.lang.String |
getText()
getText will return the textual version of the XPath
expression. |
org.jaxen.VariableContext |
getVariableContext()
DOCUMENT ME! |
boolean |
matches(Node node)
matches returns true if the given node matches the XPath
expression. |
java.lang.Number |
numberValueOf(java.lang.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. |
java.util.List |
selectNodes(java.lang.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. |
java.util.List |
selectNodes(java.lang.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. |
java.util.List |
selectNodes(java.lang.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. |
java.lang.Object |
selectObject(java.lang.Object context)
Deprecated. please use evaluate(Object) instead. WILL BE REMOVED IN dom4j-1.6 !! |
Node |
selectSingleNode(java.lang.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. |
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(java.util.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 expressions |
void |
sort(java.util.List list)
sort sorts the given List of Nodes using this XPath
expression as a Comparator . |
void |
sort(java.util.List list,
boolean distinct)
sort sorts the given List of Nodes using this XPath
expression as a Comparator and optionally removing
duplicates. |
java.lang.String |
valueOf(java.lang.Object context)
valueOf evaluates this XPath expression and returns the
textual representation of the results using the XPath string() function. |
Method Detail |
---|
java.lang.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
node
- DOCUMENT ME!
java.lang.Object evaluate(java.lang.Object context)
evaluate
evaluates an XPath expression and returns the
result as an Object
. The object returned can either be a List
of Node
instances, a Node
instance, a String
or a Number
instance depending on the XPath expression.
context
- is either a node or a list of nodes on which to evalute the
XPath
List
of Node
instances, a Node
instance, a String
or a
Number
instance depending on the XPath expression.java.lang.Object selectObject(java.lang.Object context)
selectObject
evaluates an XPath expression and returns the
result as an Object
. The object returned can either be a List
of Node
instances, a Node
instance, a String
or a Number
instance depending on the XPath expression.
context
- is either a node or a list of nodes on which to evalute the
XPath
List
of Node
instances, a Node
instance, a String
or a
Number
instance depending on the XPath expression.java.util.List selectNodes(java.lang.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
XPath
java.util.List selectNodes(java.lang.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 by
Node
instancesjava.util.List selectNodes(java.lang.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 result
Node
instancesNode selectSingleNode(java.lang.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
XPath
Node
instancejava.lang.String valueOf(java.lang.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
XPath
java.lang.Number numberValueOf(java.lang.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.
context
- is either a node or a list of nodes on which to evalute the
XPath
boolean booleanValueOf(java.lang.Object 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
return false
, while an expression that selects
one-or-more nodes will return true
.
context
- The node, nodeset or Context object for evaluation. This value
can be null
void sort(java.util.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(java.util.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)
functionContext
- DOCUMENT ME!org.jaxen.NamespaceContext getNamespaceContext()
void setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
namespaceContext
- DOCUMENT ME!void setNamespaceURIs(java.util.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:
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);
map
- the map containing the namespace mappingsorg.jaxen.VariableContext getVariableContext()
void setVariableContext(org.jaxen.VariableContext variableContext)
variableContext
- DOCUMENT ME!
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |