XPath provides access to the XPath evaluation environment and expressions.
The XPath evaluation is affected by the factors described in the following table.
| Factor | Behavior |
|---|---|
| context | The type of the context is implementation-dependent. If the value is null, the operation must have no dependency on the context, otherwise an XPathExpressionException will be thrown. For the purposes of evaluating XPath expressions, a DocumentFragment is treated like a Document node. |
| variables |
If the expression contains a variable reference, its value will be found through the XPathVariableResolver
set with setXPathVariableResolver(XPathVariableResolver resolver).
An XPathExpressionException is raised if the variable resolver is undefined or
the resolver returns null for the variable.
The value of a variable must be immutable through the course of any single evaluation.
|
| functions |
If the expression contains a function reference, the function will be found through the XPathFunctionResolver
set with setXPathFunctionResolver(XPathFunctionResolver resolver).
An XPathExpressionException is raised if the function resolver is undefined or
the function resolver returns null for the function.
|
| QNames |
QNames in the expression are resolved against the XPath namespace context
set with setNamespaceContext(NamespaceContext nsContext).
|
| result |
This result of evaluating an expression is converted to an instance of the desired return type.
Valid return types are defined in XPathConstants.
Conversion to the return type follows XPath conversion rules.
|
An XPath object is not thread-safe and not reentrant.
In other words, it is the application's responsibility to make
sure that one XPath object is not used from
more than one thread at any given time, and while the evaluate
method is invoked, applications may not recursively call
the evaluate method.
| Modifier and Type | Method and Description |
|---|---|
| public XPathExpression | |
| public Object | Returns: The result of evaluating an XPath expression as anObject of returnType.The XPath expression. expression, Object The context the XPath expression will be evaluated in. item, QName The result type expected to be returned by the XPath expression. returnType)Evaluate an |
| public String | |
| public Object | Returns: TheObject that encapsulates the result of evaluating the expression.The XPath expression. expression, InputSource The input source of the document to evaluate over. source, QName The desired return type. returnType)Evaluate an XPath expression in the context of the specified |
| public String | Returns: TheString that is the result of evaluating the expression and
converting the result to a String.The XPath expression. expression, InputSource The source)InputSource of the document to evaluate over.Evaluate an XPath expression in the context of the specified |
| public default < The class type that will be returned by the XPath expression. T> T | Returns: The result of evaluating the expression.The XPath expression. expression, Object The context the XPath expression will be evaluated in. item, Class<T> The class type expected to be returned by the XPath expression,
must be one of the types described in section
3.2 Class types
in the package summary. type)Evaluate an XPath expression in the specified context and return
the result with the type specified through the
The parameter |
| public default XPathEvaluationResult | Returns: The result of evaluating the expression.The XPath expression. expression, Object The context the XPath expression will be evaluated in. item)Evaluate an XPath expression in the specified context. |
| public default < The class type that will be returned by the XPath expression. T> T | Returns: The result of evaluating the expression.The XPath expression. expression, InputSource The input source of the document to evaluate over. source, Class<T> The class type expected to be returned by the XPath expression,
must be one of the types described in section
3.2 Class types
in the package summary. type)Evaluate an XPath expression in the context of the specified |
| public default XPathEvaluationResult | Returns: The result of evaluating the expression.The XPath expression. expression, InputSource The input source of the document to evaluate over. source)Evaluate an XPath expression in the specified context. |
| public NamespaceContext | |
| public XPathFunctionResolver | |
| public XPathVariableResolver | |
| public void | |
| public void | setNamespaceContext(NamespaceContext
Namespace context to use. nsContext)Establish a namespace context. |
| public void | setXPathFunctionResolver(XPathFunctionResolver
XPath function resolver. resolver)Establish a function resolver. |
| public void | setXPathVariableResolver(XPathVariableResolver
Variable resolver. resolver)Establish a variable resolver. |
| compile | back to summary |
|---|---|
| public XPathExpression compile(String expression) throws XPathExpressionException Compile an XPath expression for later evaluation. If If
| |
| evaluate | back to summary |
|---|---|
| public Object evaluate(String expression, Object item, QName returnType) throws XPathExpressionException Evaluate an
See Evaluation of XPath Expressions
for context item evaluation, variable, function and
The parameter Implementation Note The type of the context is usually
| |
| evaluate | back to summary |
|---|---|
| public String evaluate(String expression, Object item) throws XPathExpressionException Evaluate an XPath expression in the specified context and return the result as a This method calls See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
The parameter Implementation Note The type of the context is usually
| |
| evaluate | back to summary |
|---|---|
| public Object evaluate(String expression, InputSource source, QName returnType) throws XPathExpressionException Evaluate an XPath expression in the context of the specified This method builds a data model for the See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
| |
| evaluate | back to summary |
|---|---|
| public String evaluate(String expression, InputSource source) throws XPathExpressionException Evaluate an XPath expression in the context of the specified This method calls See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
| |
| evaluateExpression | back to summary |
|---|---|
| public default <T> T evaluateExpression(String expression, Object item, Class<T> type) throws XPathExpressionException Evaluate an XPath expression in the specified context and return
the result with the type specified through the
The parameter Implementation Note The type of the context is usually Implementation Specification The default implementation in the XPath API is equivalent to:
Since the evaluate method does not support the
ANY type, specifying
XPathEvaluationResult as the type will result in IllegalArgumentException.
Any implementation supporting the
ANY type must override
this method.
| |
| evaluateExpression | back to summary |
|---|---|
| public default XPathEvaluationResult Evaluate an XPath expression in the specified context. This is equivalent to
calling
The parameter Implementation Note The type of the context is usually Implementation Specification The default implementation in the XPath API is equivalent to:
Since the evaluate method does not support the
ANY
type, the default implementation of this method will always throw an
IllegalArgumentException. Any implementation supporting the
ANY type must therefore
override this method.
| |
| evaluateExpression | back to summary |
|---|---|
| public default <T> T evaluateExpression(String expression, InputSource source, Class<T> type) throws XPathExpressionException Evaluate an XPath expression in the context of the specified
This method builds a data model for the Implementation Specification The default implementation in the XPath API is equivalent to:
Since the evaluate method does not support the
ANY type, specifying
XPathEvaluationResult as the type will result in IllegalArgumentException.
Any implementation supporting the
ANY type must override
this method.
| |
| evaluateExpression | back to summary |
|---|---|
| public default XPathEvaluationResult Evaluate an XPath expression in the specified context. This is equivalent to
calling
Implementation Specification The default implementation in the XPath API is equivalent to:
Since the evaluate method does not support the
ANY
type, the default implementation of this method will always throw an
IllegalArgumentException. Any implementation supporting the
ANY type must therefore
override this method.
| |
| getNamespaceContext | back to summary |
|---|---|
| public NamespaceContext getNamespaceContext() Return the current namespace context.
| |
| getXPathFunctionResolver | back to summary |
|---|---|
| public XPathFunctionResolver getXPathFunctionResolver() Return the current function resolver.
| |
| getXPathVariableResolver | back to summary |
|---|---|
| public XPathVariableResolver getXPathVariableResolver() Return the current variable resolver.
| |
| reset | back to summary |
|---|---|
| public void reset() Reset this
The reset | |
| setNamespaceContext | back to summary |
|---|---|
| public void setNamespaceContext(NamespaceContext nsContext) Establish a namespace context. A
| |
| setXPathFunctionResolver | back to summary |
|---|---|
| public void setXPathFunctionResolver(XPathFunctionResolver resolver) Establish a function resolver. A
| |
| setXPathVariableResolver | back to summary |
|---|---|
| public void setXPathVariableResolver(XPathVariableResolver resolver) Establish a variable resolver. A
| |