org.milyn.cdr.xpath

Class SelectorStep

java.lang.Object

org.milyn.cdr.xpath.SelectorStep

public class SelectorStep
extends Object

XPath Expression Evaluator.

Implementations evaluate a single step in an XPath expression.

Author:

tom.fennelly@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_ELEMENT_INDEX

Constructor Summary

Constructors

Constructor and Description
SelectorStep(String xpathExpression) Public constructor.
SelectorStep(String xpathExpression, org.jaxen.expr.Step step) Public constructor.
SelectorStep(String xpathExpression, org.jaxen.expr.Step step, org.jaxen.expr.Step attributeStep) Public constructor.
SelectorStep(String xpathExpression, String targetElementName) Public constructor.
SelectorStep(String xpathExpression, String targetElementName, String targetAttributeName) Public constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accessesText() Does this step require access to the element text content.
void	buildPredicatesEvaluator(Properties namespaces)
SelectorStep	clone()
org.jaxen.expr.Step	getAttributeStep()
<T extends XPathExpressionEvaluator> void	getEvaluators(Class<T> evaluatorClass, List<T> evaluators)
XPathExpressionEvaluator	getPredicatesEvaluator()
QName	getTargetAttribute()
QName	getTargetElement()
String	getXPathExpression() Get the XPath selector expression of which this SelectorStep instance is a part.
boolean	isHashedAttribute() Is this selector step a hashed attribute selector step.
boolean	isRooted()
boolean	isStar()
boolean	isStarStar()
boolean	isTargetedAtElement(Element element)
boolean	isTargetedAtElement(SAXElement element)
boolean	isTargetedAtNamespace(String namespace) Is this StepSelector instance targeted at the specified namespace.
void	setAttributeStep(org.jaxen.expr.Step attributeStep)
static SelectorStep[]	setNamespaces(SelectorStep[] steps, Properties namespaces) Set the namespaces on the specified set of selector steps.
void	setRooted(boolean rooted)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_ELEMENT_INDEX

public static final long NO_ELEMENT_INDEX

See Also:

Constant Field Values

Constructor Detail

SelectorStep

public SelectorStep(String xpathExpression)

Public constructor.

Parameters:

xpathExpression - The XPath expression of which the Step is a part.

SelectorStep

public SelectorStep(String xpathExpression,
                    org.jaxen.expr.Step step)
             throws org.jaxen.saxpath.SAXPathException

Public constructor.

Parameters:

xpathExpression - The XPath expression of which the Step is a part.

step - The XPath Step.

Throws:

org.jaxen.saxpath.SAXPathException - Error constructing the selector step.

SelectorStep

public SelectorStep(String xpathExpression,
                    org.jaxen.expr.Step step,
                    org.jaxen.expr.Step attributeStep)
             throws org.jaxen.saxpath.SAXPathException

Public constructor.

Allows asssociation of an attribute step. XPath expressions can have the form "xxx/@abc", where the attribute "abc" is on the element "xxx".

Parameters:

xpathExpression - The XPath expression of which the Step is a part.

step - The XPath Step.

attributeStep - The Attribute Step.

Throws:

org.jaxen.saxpath.SAXPathException - Error constructing the selector step.

SelectorStep

public SelectorStep(String xpathExpression,
                    String targetElementName)

Public constructor.

Parameters:

xpathExpression - The XPath expression of which the Step is a part.

targetElementName - The target element name associated with this selector step.

SelectorStep

public SelectorStep(String xpathExpression,
                    String targetElementName,
                    String targetAttributeName)

Public constructor.

Parameters:

xpathExpression - The XPath expression of which the Step is a part.

targetElementName - The target element name associated with this selector step.

targetAttributeName - The target attribute name associated with this selector step.

Method Detail

getAttributeStep

public org.jaxen.expr.Step getAttributeStep()

setAttributeStep

public void setAttributeStep(org.jaxen.expr.Step attributeStep)

clone

public SelectorStep clone()

Overrides:

clone in class Object

getXPathExpression

public String getXPathExpression()

Get the XPath selector expression of which this SelectorStep instance is a part.

Returns:

The XPath selector expression of which this SelectorStep instance is a part.

getTargetElement

public QName getTargetElement()

getTargetAttribute

public QName getTargetAttribute()

getPredicatesEvaluator

public XPathExpressionEvaluator getPredicatesEvaluator()

isRooted

public boolean isRooted()

setRooted

public void setRooted(boolean rooted)

isStar

public boolean isStar()

isStarStar

public boolean isStarStar()

buildPredicatesEvaluator

public void buildPredicatesEvaluator(Properties namespaces)
                              throws org.jaxen.saxpath.SAXPathException,
                                     javassist.NotFoundException,
                                     javassist.CannotCompileException,
                                     IllegalAccessException,
                                     InstantiationException

Throws:

org.jaxen.saxpath.SAXPathException

javassist.NotFoundException

javassist.CannotCompileException

IllegalAccessException

InstantiationException

isTargetedAtElement

public boolean isTargetedAtElement(SAXElement element)

isTargetedAtElement

public boolean isTargetedAtElement(Element element)

isTargetedAtNamespace

public boolean isTargetedAtNamespace(String namespace)

Is this StepSelector instance targeted at the specified namespace.

If the StepSelector namespace is null, it automatically matches and no comparison is made against the supplied namespace.

Parameters:

namespace - The namespace to be tested.

Returns:

True if the target namespace matches (or is null), otherwise false.

accessesText

public boolean accessesText()

Does this step require access to the element text content.

Does this step include a 'text()' predicate at any level.

Returns:

True if the step requires access to the element's text content, otherwise false.

getEvaluators

public <T extends XPathExpressionEvaluator> void getEvaluators(Class<T> evaluatorClass,
                                                               List<T> evaluators)

toString

public String toString()

Overrides:

toString in class Object

setNamespaces

public static SelectorStep[] setNamespaces(SelectorStep[] steps,
                                           Properties namespaces)
                                    throws org.jaxen.saxpath.SAXPathException

Set the namespaces on the specified set of selector steps.

Parameters:

steps - The selector steps.

namespaces - The set of selector steps to be updated.

Returns:

The set of selector steps (as passed in the 'steps' argument).

Throws:

org.jaxen.saxpath.SAXPathException - Error setting namespaces

isHashedAttribute

public boolean isHashedAttribute()

Is this selector step a hashed attribute selector step.

Returns:

True if the selector step is a hashed attribute selector, otherwise false.