| java.lang.Object
 org.apache.xpath.jaxp.XPathImpl
| XPathImpl | | public class XPathImpl implements javax.xml.xpath.XPath(Code) | | The XPathImpl class provides implementation for the methods defined in
javax.xml.xpath.XPath interface. This provide simple access to the results
of an XPath expression.
version:
$Revision: 1.1 $
author:
Ramesh Mandava |
| Method Summary | |
| public XPathExpression | compile(String expression)
Compile an XPath expression for later evaluation.
If expression contains any
XPathFunction s,
they must be available via the
XPathFunctionResolver .
An
XPathExpressionException will be thrown if the XPathFunction
cannot be resovled with the XPathFunctionResolver.
If expression is null, a NullPointerException is thrown.
Parameters:
expression - The XPath expression. | | public Object | evaluate(String expression, Object item, QName returnType)
Evaluate an XPath expression in the specified context and return the result as the specified type.
See "Evaluation of XPath Expressions" section of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If returnType is not one of the types defined in
XPathConstants (
XPathConstants.NUMBER NUMBER ,
XPathConstants.STRING STRING ,
XPathConstants.BOOLEAN BOOLEAN ,
XPathConstants.NODE NODE or
XPathConstants.NODESET NODESET )
then an IllegalArgumentException is thrown.
If a null value is provided for
item, an empty document will be used for the
context.
If expression or returnType is null, then a
NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
item - The starting context (node or node list, for example).
Parameters:
returnType - The desired return type. | | public String | evaluate(String expression, Object item)
Evaluate an XPath expression in the specified context and return the result as a String.
This method calls
XPathImpl.evaluate(String expression,Object item,QName returnType) with a returnType of
XPathConstants.STRING .
See "Evaluation of XPath Expressions" of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If a null value is provided for
item, an empty document will be used for the
context.
If expression is null, then a NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
item - The starting context (node or node list, for example). | | public Object | evaluate(String expression, InputSource source, QName returnType)
Evaluate an XPath expression in the context of the specified InputSource
and return the result as the specified type.
This method builds a data model for the
InputSource and calls
XPathImpl.evaluate(String expression,Object item,QName returnType) on the resulting document object.
See "Evaluation of XPath Expressions" section of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If returnType is not one of the types defined in
XPathConstants ,
then an IllegalArgumentException is thrown.
If expression, source or returnType is null,
then a NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
source - The input source of the document to evaluate over.
Parameters:
returnType - The desired return type. | | public String | evaluate(String expression, InputSource source)
Evaluate an XPath expression in the context of the specified InputSource
and return the result as a String.
This method calls
XPathImpl.evaluate(String expression,InputSource source,QName returnType) with a
returnType of
XPathConstants.STRING .
See "Evaluation of XPath Expressions" section of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If expression or source is null,
then a NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
source - The InputSource of the document to evaluate over. | | public NamespaceContext | getNamespaceContext()
| | public XPathFunctionResolver | getXPathFunctionResolver()
| | public XPathVariableResolver | getXPathVariableResolver()
| | public void | reset()
Reset this XPath to its original configuration.
XPath is reset to the same state as when it was created with
XPathFactory.newXPath .
reset() is designed to allow the reuse of existing XPaths
thus saving resources associated with the creation of new XPaths.
The reset XPath is not guaranteed to have the same
XPathFunctionResolver ,
XPathVariableResolver or
NamespaceContext Objects, e.g. | | public void | setNamespaceContext(NamespaceContext nsContext)
| | public void | setXPathFunctionResolver(XPathFunctionResolver resolver)
| | public void | setXPathVariableResolver(XPathVariableResolver resolver)
|
| evaluate | | public Object evaluate(String expression, Object item, QName returnType) throws XPathExpressionException(Code) | | Evaluate an XPath expression in the specified context and return the result as the specified type.
See "Evaluation of XPath Expressions" section of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If returnType is not one of the types defined in
XPathConstants (
XPathConstants.NUMBER NUMBER ,
XPathConstants.STRING STRING ,
XPathConstants.BOOLEAN BOOLEAN ,
XPathConstants.NODE NODE or
XPathConstants.NODESET NODESET )
then an IllegalArgumentException is thrown.
If a null value is provided for
item, an empty document will be used for the
context.
If expression or returnType is null, then a
NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
item - The starting context (node or node list, for example).
Parameters:
returnType - The desired return type. Result of evaluating an XPath expression as an Object of returnType.
throws:
XPathExpressionException - If expression cannot be evaluated.
throws:
IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.
throws:
NullPointerException - If expression or returnType is null. |
| evaluate | | public String evaluate(String expression, Object item) throws XPathExpressionException(Code) | | Evaluate an XPath expression in the specified context and return the result as a String.
This method calls
XPathImpl.evaluate(String expression,Object item,QName returnType) with a returnType of
XPathConstants.STRING .
See "Evaluation of XPath Expressions" of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If a null value is provided for
item, an empty document will be used for the
context.
If expression is null, then a NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
item - The starting context (node or node list, for example). The String that is the result of evaluating the expression andconverting the result to a String.
throws:
XPathExpressionException - If expression cannot be evaluated.
throws:
NullPointerException - If expression is null. |
| evaluate | | public Object evaluate(String expression, InputSource source, QName returnType) throws XPathExpressionException(Code) | | Evaluate an XPath expression in the context of the specified InputSource
and return the result as the specified type.
This method builds a data model for the
InputSource and calls
XPathImpl.evaluate(String expression,Object item,QName returnType) on the resulting document object.
See "Evaluation of XPath Expressions" section of JAXP 1.3 spec
for context item evaluation,
variable, function and QName resolution and return type conversion.
If returnType is not one of the types defined in
XPathConstants ,
then an IllegalArgumentException is thrown.
If expression, source or returnType is null,
then a NullPointerException is thrown.
Parameters:
expression - The XPath expression.
Parameters:
source - The input source of the document to evaluate over.
Parameters:
returnType - The desired return type. The Object that encapsulates the result of evaluating the expression.
throws:
XPathExpressionException - If expression cannot be evaluated.
throws:
IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.
throws:
NullPointerException - If expression, source or returnTypeis null. |
| getNamespaceContext | | public NamespaceContext getNamespaceContext()(Code) | | Returns the current namespace context.
Current Namespace context |
| getXPathFunctionResolver | | public XPathFunctionResolver getXPathFunctionResolver()(Code) | | Returns the current function resolver.
Current function resolver |
| getXPathVariableResolver | | public XPathVariableResolver getXPathVariableResolver()(Code) | | Returns the current variable resolver.
Current variable resolver |
| reset | | public void reset()(Code) | | Reset this XPath to its original configuration.
XPath is reset to the same state as when it was created with
XPathFactory.newXPath .
reset() is designed to allow the reuse of existing XPaths
thus saving resources associated with the creation of new XPaths.
The reset XPath is not guaranteed to have the same
XPathFunctionResolver ,
XPathVariableResolver or
NamespaceContext Objects, e.g.
Object.equals(Object obj) .
It is guaranteed to have a functionally equal XPathFunctionResolver,
XPathVariableResolver
and NamespaceContext.
|
| setNamespaceContext | | public void setNamespaceContext(NamespaceContext nsContext)(Code) | | Establishes a namespace context.
Parameters:
nsContext - Namespace context to use |
| setXPathFunctionResolver | | public void setXPathFunctionResolver(XPathFunctionResolver resolver)(Code) | | Establishes a function resolver.
Parameters:
resolver - XPath function resolver |
| setXPathVariableResolver | | public void setXPathVariableResolver(XPathVariableResolver resolver)(Code) | | Establishes a variable resolver.
Parameters:
resolver - Variable Resolver |
|
|