org.hudsonci.xpath.impl

Class XPathJavaImpl

java.lang.Object

org.hudsonci.xpath.impl.XPathJavaImpl

All Implemented Interfaces:

XPathAPI

public class XPathJavaImpl
extends Object
implements XPathAPI

Implementation of XPathAPI using javax.xml.xpath.

Author:

Bob Foster

Constructor Summary

Constructors

Constructor and Description
XPathJavaImpl(String expr)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	booleanValueOf(Object xpathContext) Return boolean result of evaluating expression.
Object	evaluate(Object xpathContext) Evaluate expression and return an appropriate value, one of: Node, NodeList, String, Boolean or Double.
XFunctionFilter	getFunctionFilter()
XNamespaceContext	getNamespaceContext() Get namespace context.
XVariableContext	getVariableContext() Get variable context.
double	numberValueOf(Object xpathContext) Return double result of evaluating expression.
List	selectNodes(Object xpathContext) Return List of Node result of evaluating expression.
org.dom4j.Node	selectSingleNode(Object xpathContext) Return Node result of evaluating expression.
void	setExpr(String expr) Reset the XPath expression.
void	setFunctionFilter(XFunctionFilter filter)
void	setNamespaceContext(XNamespaceContext nsContext) Get namespace context used when evaluating XPath expression.
void	setVariableContext(XVariableContext varContext) Set variable context used when evaluating XPath expression.
String	stringValueOf(Object xpathContext) Return String result of evaluating expression.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathJavaImpl

public XPathJavaImpl(String expr)

Method Detail

setFunctionFilter

public void setFunctionFilter(XFunctionFilter filter)

Specified by:

setFunctionFilter in interface XPathAPI

getFunctionFilter

public XFunctionFilter getFunctionFilter()

Specified by:

getFunctionFilter in interface XPathAPI

setVariableContext

public void setVariableContext(XVariableContext varContext)

Set variable context used when evaluating XPath expression.

Specified by:

setVariableContext in interface XPathAPI

Parameters:

varContext -

getVariableContext

public XVariableContext getVariableContext()

Get variable context.

Specified by:

getVariableContext in interface XPathAPI

Returns:

previously set variable context.

setNamespaceContext

public void setNamespaceContext(XNamespaceContext nsContext)

Get namespace context used when evaluating XPath expression.

Specified by:

setNamespaceContext in interface XPathAPI

Parameters:

nsContext -

getNamespaceContext

public XNamespaceContext getNamespaceContext()

Get namespace context.

Specified by:

getNamespaceContext in interface XPathAPI

Returns:

previously set namespace context

evaluate

public Object evaluate(Object xpathContext)
                throws XPathException

Evaluate expression and return an appropriate value, one of: Node, NodeList, String, Boolean or Double.

Specified by:

evaluate in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

result of evaluation

Throws:

XPathException - if errors detected

booleanValueOf

public boolean booleanValueOf(Object xpathContext)
                       throws XPathException

Return boolean result of evaluating expression.

Specified by:

booleanValueOf in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

boolean

Throws:

XPathException - if errors detected

numberValueOf

public double numberValueOf(Object xpathContext)
                     throws XPathException

Return double result of evaluating expression. Any number is converted to double.

Specified by:

numberValueOf in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

double

Throws:

XPathException

stringValueOf

public String stringValueOf(Object xpathContext)
                     throws XPathException

Return String result of evaluating expression.

Specified by:

stringValueOf in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

String

Throws:

XPathException

selectSingleNode

public org.dom4j.Node selectSingleNode(Object xpathContext)
                                throws XPathException

Return Node result of evaluating expression. If the result has more than one Node, one of the Nodes is returned. If result has no Nodes, throws XPathException.

Specified by:

selectSingleNode in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

Node

Throws:

XPathException

selectNodes

public List selectNodes(Object xpathContext)
                 throws XPathException

Return List of Node result of evaluating expression.

Specified by:

selectNodes in interface XPathAPI

Parameters:

xpathContext - must be an org.dom4j.Node or null if expression contains a Node-valued variable that can be used to establish the context.

Returns:

List of Nodes, may be empty

Throws:

XPathException

toString

public String toString()

Specified by:

toString in interface XPathAPI

Overrides:

toString in class Object

Returns:

XPath expression

setExpr

public void setExpr(String expr)

Reset the XPath expression. Used for debugging.

Specified by:

setExpr in interface XPathAPI

Parameters:

expr -