org.xmlbeam.evaluation

Class DefaultXPathEvaluator

java.lang.Object

org.xmlbeam.evaluation.DefaultXPathEvaluator

All Implemented Interfaces:

XPathEvaluator

public final class DefaultXPathEvaluator
extends Object
implements XPathEvaluator

This class is used to provide an fluid interface for direct evaluation of XPath expressions.

Author:

sven

Constructor Summary

Constructors

Constructor and Description
DefaultXPathEvaluator(XBProjector projector, DocumentResolver documentProvider, String xpath) Constructor for DefaultXPathEvaluator.

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> returnType) Evaluate the XPath as a value of the given type.
<T> T[]	asArrayOf(Class<T> componentType) Evaluate the XPath as an array of the given type.
boolean	asBoolean() Evaluates the XPath as a boolean value.
Date	asDate() Evaluates the XPath as a Date value.
int	asInt() Evaluates the XPath as a int value.
<T> List<T>	asListOf(Class<T> componentType) Evaluate the XPath as a list of the given type.
String	asString() Evaluates the XPath as a String value.
static List<?>	evaluateAsList(XPathExpression expression, Node node, Method method, InvocationContext invocationContext) Perform an XPath evaluation on an invocation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXPathEvaluator

public DefaultXPathEvaluator(XBProjector projector,
                             DocumentResolver documentProvider,
                             String xpath)

Constructor for DefaultXPathEvaluator.

Parameters:

projector -

documentProvider -

xpath -

Method Detail

asBoolean

public boolean asBoolean()

Evaluates the XPath as a boolean value. This method is just a shortcut for as(Boolean.TYPE);

Specified by:

asBoolean in interface XPathEvaluator

Returns:

true when the selected value equals (ignoring case) 'true'

asInt

public int asInt()

Evaluates the XPath as a int value. This method is just a shortcut for as(Integer.TYPE);

Specified by:

asInt in interface XPathEvaluator

Returns:

int value of evaluation result.

asString

public String asString()

Evaluates the XPath as a String value. This method is just a shortcut for as(String.class);

Specified by:

asString in interface XPathEvaluator

Returns:

String value of evaluation result.

asDate

public Date asDate()

Evaluates the XPath as a Date value. This method is just a shortcut for as(Date.class); You probably want to specify ' using ' followed by some formatting pattern consecutive to the XPAth.

Specified by:

asDate in interface XPathEvaluator

Returns:

Date value of evaluation result.

as

public <T> T as(Class<T> returnType)

Evaluate the XPath as a value of the given type.

Specified by:

as in interface XPathEvaluator

Parameters:

returnType - Possible values: primitive types (e.g. Short.Type), Projection interfaces, any class with a String constructor or a String factory method, and org.w3c.Node

Returns:

a value of return type that reflects the evaluation result.

asArrayOf

public <T> T[] asArrayOf(Class<T> componentType)

Evaluate the XPath as an array of the given type.

Specified by:

asArrayOf in interface XPathEvaluator

Parameters:

componentType - Possible values: primitive types (e.g. Short.Type), Projection interfaces, any class with a String constructor or a String factory method, and org.w3c.Node

Returns:

an array of return type that reflects the evaluation result.

asListOf

public <T> List<T> asListOf(Class<T> componentType)

Evaluate the XPath as a list of the given type.

Specified by:

asListOf in interface XPathEvaluator

Parameters:

componentType - Possible values: primitive types (e.g. Short.Type), Projection interfaces, any class with a String constructor or a String factory method, and org.w3c.Node

Returns:

List of return type that reflects the evaluation result.

evaluateAsList

public static List<?> evaluateAsList(XPathExpression expression,
                                     Node node,
                                     Method method,
                                     InvocationContext invocationContext)
                              throws XPathExpressionException

Perform an XPath evaluation on an invocation context.

Parameters:

expression -

node -

method -

invocationContext -

Returns:

a list of evaluation results

Throws:

XPathExpressionException