-
public interface XPathExpression
TheXPathExpression
interface represents a parsed and resolved XPath expression.See also the Document Object Model (DOM) Level 3 XPath Specification.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
evaluate(Node contextNode, short type, Object result)
Evaluates this XPath expression and returns a result.
-
-
-
Method Detail
evaluate
Object evaluate(Node contextNode, short type, Object result) throws XPathException, DOMException
Evaluates this XPath expression and returns a result.- Parameters:
contextNode
- Thecontext
is context node for the evaluation of this XPath expression.If the XPathEvaluator was obtained by casting theDocument
then this must be owned by the same document and must be aDocument
,Element
,Attribute
,Text
,CDATASection
,Comment
,ProcessingInstruction
, orXPathNamespace
node.If the context node is aText
or aCDATASection
, then the context is interpreted as the whole logical text node as seen by XPath, unless the node is empty in which case it may not serve as the XPath context.type
- If a specifictype
is specified, then the result will be coerced to return the specified type relying on XPath conversions and fail if the desired coercion is not possible. This must be one of the type codes ofXPathResult
.result
- Theresult
specifies a specific result object which may be reused and returned by this method. If this is specified asnull
or the implementation does not reuse the specified result, a new result object will be constructed and returned.For XPath 1.0 results, this object will be of typeXPathResult
.- Returns:
-
The result of the evaluation of the XPath expression.For XPath 1.0 results, this object will be of type
XPathResult
. - Throws:
XPathException
- TYPE_ERR: Raised if the result cannot be converted to return the specified type.DOMException
- WRONG_DOCUMENT_ERR: The Node is from a document that is not supported by the XPathEvaluator that created thisXPathExpression
.
NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the request type is not permitted by thisXPathExpression
.
-