org.w3c.dom.xpath
Interface XPathExpression


public interface XPathExpression

DOM Level 3 WD Experimental: The DOM Level 3 specification is at the stage of Working Draft, which represents work in progress and thus may be updated, replaced, or obsoleted by other documents at any time.

The XPathExpression interface represents a parsed and resolved XPath expression.The evaluateExpression method should be moved to the XPathExpression interface so you do not have to use / pass two interfaces just to use it.Done.XPathExpression should have a public reference to the XPathEvaluator that created it.No change.Lacks justification.

See also the Document Object Model (DOM) Level 3 XPath Specification.


Method Summary
 java.lang.Object evaluate(Node contextNode, short type, java.lang.Object result)
          Evaluates this XPath expression and returns a result.
 

Method Detail

evaluate

public java.lang.Object evaluate(Node contextNode,
                                 short type,
                                 java.lang.Object result)
                          throws XPathException,
                                 DOMException
Evaluates this XPath expression and returns a result.

Parameters:
contextNode - The context is context node for the evaluation of this XPath expression.If the XPathEvaluator was obtained by casting the Document then this must be owned by the same document and must be a Document, Element, Attribute, Text, CDATASection, Comment, ProcessingInstruction, or XPathNamespace node.If the context node is a Text or a CDATASection, 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 specific type 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 of XPathResult.
result - The result specifies a specific XPathResult which may be reused and returned by this method. If this is specified as nullor the implementation cannot reuse the specified result, a new XPathResult will be constructed and returned.
Returns:
The result of the evaluation of the XPath expression.
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 XPathExpression that created this XPathExpression.
NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node.


Copyright ? 1999-2004 Apache XML Project. All Rights Reserved.