| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
 XPath represents an XPath expression after it has been parsed
 from a String.
 
| 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)evaluateevaluates an XPath expression and returns the
 result as anObject. | 
|  org.jaxen.FunctionContext | getFunctionContext()DOCUMENT ME! | 
|  org.jaxen.NamespaceContext | getNamespaceContext()DOCUMENT ME! | 
|  String | getText()getTextwill return the textual version of the XPath
 expression. | 
|  org.jaxen.VariableContext | getVariableContext()DOCUMENT ME! | 
|  boolean | matches(Node node)matchesreturns true if the given node matches the XPath
 expression. | 
|  Number | numberValueOf(Object context)numberValueOfevaluates 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)selectNodesperforms this XPath expression on the givenNodeorListofNodes instances appending all
 the results together into a single list. | 
|  List | selectNodes(Object context,
            XPath sortXPath)selectNodesevaluates the XPath expression on the givenNodeorListofNodes and returns the result as
 aListofNodes sorted by the sort XPath
 expression. | 
|  List | selectNodes(Object context,
            XPath sortXPath,
            boolean distinct)selectNodesevaluates the XPath expression on the givenNodeorListofNodes and returns the result as
 aListofNodes 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)selectSingleNodeevaluates this XPath expression on the
 givenNodeorListofNodes and returns the
 result as a singleNodeinstance. | 
|  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)sortsorts the given List of Nodes using this XPath
 expression as aComparator. | 
|  void | sort(List list,
     boolean distinct)sortsorts the given List of Nodes using this XPath
 expression as aComparatorand optionally removing
 duplicates. | 
|  String | valueOf(Object context)valueOfevaluates this XPath expression and returns the
 textual representation of the results using the XPath string() function. | 
| Method Detail | 
public String getText()
 getText will return the textual version of the XPath
 expression.
 
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.
 
matches in interface NodeFilternode - DOCUMENT ME!
public Object evaluate(Object context)
 evaluate evaluates an XPath expression and returns the
 result as an Object. The object returned can either be a List of Nodeinstances, a Nodeinstance, a String or a Numberinstance depending on the XPath expression.
 
context - is either a node or a list of nodes on which to evalute the
            XPath
Listof Node instances, a Nodeinstance, a Stringor a
         Numberinstance depending on the XPath expression.public Object selectObject(Object context)
 selectObject evaluates an XPath expression and returns the
 result as an Object. The object returned can either be a List of Nodeinstances, a Nodeinstance, a String or a Numberinstance depending on the XPath expression.
 
context - is either a node or a list of nodes on which to evalute the
            XPath
Listof Node instances, a Nodeinstance, a Stringor a
         Numberinstance depending on the XPath expression.public 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.
 
context - is either a node or a list of nodes on which to evalute the
            XPath
public 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.
 
context - is either a node or a list of nodes on which to evalute the
            XPathsortXPath - is the XPath expression to sort by
Node instances
public 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.
 
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 instancespublic Node selectSingleNode(Object context)
 selectSingleNode evaluates this XPath expression on the
 given Nodeor Listof Nodes 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 instancepublic String 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
            XPath
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.
 
context - is either a node or a list of nodes on which to evalute the
            XPath
public boolean booleanValueOf(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
public void sort(List list)
 sort sorts the given List of Nodes using this XPath
 expression as a Comparator.
 
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 a Comparatorand 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 Listpublic org.jaxen.FunctionContext getFunctionContext()
public void setFunctionContext(org.jaxen.FunctionContext functionContext)
functionContext - DOCUMENT ME!public org.jaxen.NamespaceContext getNamespaceContext()
public void setNamespaceContext(org.jaxen.NamespaceContext namespaceContext)
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);
 
 
 
map - the map containing the namespace mappingspublic org.jaxen.VariableContext getVariableContext()
public 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 | ||||||||||