Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface XPath
extends NodeFilter
XPath
represents an XPath expression after it has been parsed
from a String.
Method Summary | |
boolean |
|
Object |
|
FunctionContext |
|
NamespaceContext |
|
String |
|
VariableContext |
|
boolean | |
Number |
|
List |
|
List |
|
List |
|
Object |
|
Node |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
Methods inherited from interface org.dom4j.NodeFilter | |
matches |
public boolean booleanValueOf(Object context)
Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context. The boolean-value of the expression is determined per theboolean(..)
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
public Object evaluate(Object context)
evaluate
evaluates an XPath expression and returns the result as anObject
. The object returned can either be aList
ofNode
instances, aNode
instance, aString
or aNumber
instance depending on the XPath expression.
- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath
public FunctionContext getFunctionContext()
DOCUMENT ME!
- Returns:
- the current function context
public NamespaceContext getNamespaceContext()
DOCUMENT ME!
- Returns:
- the current namespace context
public String getText()
getText
will return the textual version of the XPath expression.
- Returns:
- the textual format of the XPath expression.
public VariableContext getVariableContext()
DOCUMENT ME!
- Returns:
- the current variable context
public 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.
- Specified by:
- matches in interface NodeFilter
- Parameters:
node
- DOCUMENT ME!
- Returns:
- true if the given node matches this XPath expression
public Number 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.
- 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.
public List selectNodes(Object context)
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
public List selectNodes(Object context, XPath sortXPath)
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
public List selectNodes(Object context, XPath sortXPath, boolean distinct)
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
public Object selectObject(Object context)
Deprecated. please use evaluate(Object) instead. WILL BE REMOVED IN dom4j-1.6 !!
selectObject
evaluates an XPath expression and returns the result as anObject
. The object returned can either be aList
ofNode
instances, aNode
instance, aString
or aNumber
instance depending on the XPath expression.
- Parameters:
context
- is either a node or a list of nodes on which to evalute the XPath
public Node selectSingleNode(Object context)
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
public void setFunctionContext(FunctionContext functionContext)
Sets the function context to be used when evaluating XPath expressions
- Parameters:
functionContext
- DOCUMENT ME!
public void setNamespaceContext(NamespaceContext namespaceContext)
Sets the namespace context to be used when evaluating XPath expressions
- Parameters:
namespaceContext
- DOCUMENT ME!
public 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: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
public void setVariableContext(VariableContext variableContext)
Sets the variable context to be used when evaluating XPath expressions
- Parameters:
variableContext
- DOCUMENT ME!
public void sort(List list)
sort
sorts the given List of Nodes using this XPath expression as ajava.util.Comparator
.
- Parameters:
list
- is the list of Nodes to sort
public void sort(List list, boolean distinct)
sort
sorts the given List of Nodes using this XPath expression as ajava.util.Comparator
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
public String valueOf(Object context)
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