org.dom4j
Interface XPath

All Superinterfaces:
NodeFilter

public interface XPath
extends NodeFilter

XPath represents an XPath expression after it has been parsed from a String.

Version:
$Revision: 1.20 $
Author:
James Strachan

Method Summary
 boolean booleanValueOf(Object context)
          Retrieve a boolean-value interpretation of this XPath expression when evaluated against a given context.
 Object evaluate(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!
 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.
 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.
 List selectNodes(Object context)
           selectNodes performs this XPath expression on the given Nodeor Listof Nodes instances appending all the results together into a single list.
 List selectNodes(Object context, XPath sortXPath)
           selectNodes evaluates the XPath expression on the given Nodeor Listof Nodes and returns the result as a List of Node s sorted by the sort XPath expression.
 List selectNodes(Object context, XPath sortXPath, boolean distinct)
           selectNodes evaluates the XPath expression on the given Nodeor Listof Nodes and returns the result as a List of Node s sorted by the sort XPath expression.
 Object selectObject(Object context)
          Deprecated. please use evaluate(Object) instead. WILL BE REMOVED IN dom4j-1.6 !!
 Node selectSingleNode(Object context)
           selectSingleNode evaluates this XPath expression on the given Nodeor Listof Nodes 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(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(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 Comparatorand 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.
 

Method Detail

getText

String getText()

getText will return the textual version of the XPath expression.

Returns:
the textual format of the XPath expression.

matches

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

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the given node matches this XPath expression

evaluate

Object evaluateParameters:
node - DOCUMENT ME!
Returns:
true if the giv