org.jaxen.expr
Interface Step

All Superinterfaces:
Predicated, java.io.Serializable, Visitable
All Known Subinterfaces:
AllNodeStep, CommentNodeStep, NameStep, ProcessingInstructionNodeStep, TextNodeStep
All Known Implementing Classes:
DefaultAllNodeStep, DefaultCommentNodeStep, DefaultNameStep, DefaultProcessingInstructionNodeStep, DefaultStep, DefaultTextNodeStep

public interface Step
extends Predicated, Visitable

A Step represents a location step in a LocationPath. The node-set selected by the location step is the node-set that results from generating an initial node-set from the axis and node-test, and then filtering that node-set by each of the predicates in turn. The initial node-set consists of the nodes having the relationship to the context node specified by the axis, and having the node type and expanded-name specified by the node test.


Method Summary
 java.util.Iterator axisIterator(java.lang.Object contextNode, ContextSupport support)
          Get an Iterator for the current axis starting in the given contextNode.
 java.util.List evaluate(Context context)
          For each node in the given context calls matches() for every node on the axis, then filters the result by each of the predicates.
 int getAxis()
          Get an identifier for the current axis.
 java.lang.String getText()
           
 boolean matches(java.lang.Object node, ContextSupport contextSupport)
          Performs the node-test part of evaluating the step for the given node (which must be on the axis).
 void simplify()
           
 
Methods inherited from interface org.jaxen.expr.Predicated
addPredicate, getPredicates, getPredicateSet
 
Methods inherited from interface org.jaxen.expr.Visitable
accept
 

Method Detail

matches

public boolean matches(java.lang.Object node,
                       ContextSupport contextSupport)
Performs the node-test part of evaluating the step for the given node (which must be on the axis).


getText

public java.lang.String getText()

simplify

public void simplify()

getAxis

public int getAxis()
Get an identifier for the current axis.

See Also:
Axis

axisIterator

public java.util.Iterator axisIterator(java.lang.Object contextNode,
                                       ContextSupport support)
                                throws UnsupportedAxisException
Get an Iterator for the current axis starting in the given contextNode.

Throws:
UnsupportedAxisException

evaluate

public java.util.List evaluate(Context context)
                        throws JaxenException
For each node in the given context calls matches() for every node on the axis, then filters the result by each of the predicates.

Throws:
JaxenException