org.apache.xpath.jaxp

Class XPathExpressionImpl

java.lang.Object

org.apache.xpath.jaxp.XPathExpressionImpl

All Implemented Interfaces:

XPathExpression

public class XPathExpressionImpl
extends Object
implements XPathExpression

The XPathExpression interface encapsulates a (compiled) XPath expression.

Version:

$Revision$

Author:

Ramesh Mandava

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XPathExpressionImpl() Protected constructor to prevent direct instantiation; use compile() from the context.
protected	XPathExpressionImpl(XPath xpath, JAXPPrefixResolver prefixResolver, XPathFunctionResolver functionResolver, XPathVariableResolver variableResolver)
protected	XPathExpressionImpl(XPath xpath, JAXPPrefixResolver prefixResolver, XPathFunctionResolver functionResolver, XPathVariableResolver variableResolver, boolean featureSecureProcessing)

Method Summary

Methods

Modifier and Type	Method and Description
Object	eval(Object item, QName returnType)
String	evaluate(InputSource source) Evaluate the compiled XPath expression in the context of the specified InputSource and return the result as a String.
Object	evaluate(InputSource source, QName returnType) Evaluate the compiled XPath expression in the context of the specified InputSource and return the result as the specified type.
String	evaluate(Object item) Evaluate the compiled XPath expression in the specified context and return the result as a String.
Object	evaluate(Object item, QName returnType) Evaluate the compiled XPath expression in the specified context and return the result as the specified type.
void	setXPath(XPath xpath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XPathExpressionImpl

protected XPathExpressionImpl()

Protected constructor to prevent direct instantiation; use compile() from the context.

XPathExpressionImpl

protected XPathExpressionImpl(XPath xpath,
                   JAXPPrefixResolver prefixResolver,
                   XPathFunctionResolver functionResolver,
                   XPathVariableResolver variableResolver)

XPathExpressionImpl

protected XPathExpressionImpl(XPath xpath,
                   JAXPPrefixResolver prefixResolver,
                   XPathFunctionResolver functionResolver,
                   XPathVariableResolver variableResolver,
                   boolean featureSecureProcessing)

Method Detail

setXPath

public void setXPath(XPath xpath)

eval

public Object eval(Object item,
          QName returnType)
            throws TransformerException

Throws:

TransformerException

evaluate

public Object evaluate(Object item,
              QName returnType)
                throws XPathExpressionException

Evaluate the compiled 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, then an IllegalArgumentException is thrown.

If a null value is provided for item, an empty document will be used for the context. If returnType is null, then a NullPointerException is thrown.

Specified by:

evaluate in interface XPathExpression

Parameters:

item - The starting context (node or node list, for example).

returnType - The desired return type.

Returns:

The Object that is the result of evaluating the expression and converting the result to returnType.

Throws:

XPathExpressionException - If the expression cannot be evaluated.

IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.

NullPointerException - If returnType is null.

evaluate

public String evaluate(Object item)
                throws XPathExpressionException

Evaluate the compiled XPath expression in the specified context and return the result as a String.

This method calls evaluate(Object item, 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 a null value is provided for item, an empty document will be used for the context.

Specified by:

evaluate in interface XPathExpression

Parameters:

item - The starting context (node or node list, for example).

Returns:

The String that is the result of evaluating the expression and converting the result to a String.

Throws:

XPathExpressionException - If the expression cannot be evaluated.

evaluate

public Object evaluate(InputSource source,
              QName returnType)
                throws XPathExpressionException

Evaluate the compiled 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 evaluate(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 source or returnType is null, then a NullPointerException is thrown.

Specified by:

evaluate in interface XPathExpression

Parameters:

source - The InputSource of the document to evaluate over.

returnType - The desired return type.

Returns:

The Object that is the result of evaluating the expression and converting the result to returnType.

Throws:

XPathExpressionException - If the expression cannot be evaluated.

IllegalArgumentException - If returnType is not one of the types defined in XPathConstants.

NullPointerException - If source or returnType is null.

evaluate

public String evaluate(InputSource source)
                throws XPathExpressionException

Evaluate the compiled XPath expression in the context of the specified InputSource and return the result as a String.

This method calls evaluate(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 source is null, then a NullPointerException is thrown.

Specified by:

evaluate in interface XPathExpression

Parameters:

source - The InputSource of the document to evaluate over.

Returns:

The String that is the result of evaluating the expression and converting the result to a String.

Throws:

XPathExpressionException - If the expression cannot be evaluated.

NullPointerException - If source is null.