Package org.loboevolution.apache.xpath.axes

Class OneStepIteratorForward

java.lang.Object

org.loboevolution.apache.xpath.Expression

org.loboevolution.apache.xpath.patterns.NodeTest

org.loboevolution.apache.xpath.axes.PredicatedNodeTest

org.loboevolution.apache.xpath.axes.LocPathIterator

org.loboevolution.apache.xpath.axes.BasicTestIterator

org.loboevolution.apache.xpath.axes.ChildTestIterator

org.loboevolution.apache.xpath.axes.OneStepIteratorForward

All Implemented Interfaces:

Cloneable, SourceLocator, DTMIterator, PathComponent, SubContextList, ExpressionNode, XPathVisitable

public class OneStepIteratorForward
extends ChildTestIterator

This class implements a general iterator for those LocationSteps with only one step, and perhaps a predicate, that only go forward (i.e. it can not be used with ancestors, preceding, etc.)

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_axis	The traversal axis from where the nodes will be filtered.

Fields inherited from class org.loboevolution.apache.xpath.axes.ChildTestIterator

m_traverser

Fields inherited from class org.loboevolution.apache.xpath.axes.LocPathIterator

m_allowDetach, m_cdtm, m_clones, m_context, m_currentContextNode, m_execContext, m_lastFetched, m_length, m_pos

Fields inherited from class org.loboevolution.apache.xpath.axes.PredicatedNodeTest

m_foundLast, m_lpi, m_predCount, m_proximityPositions

Fields inherited from class org.loboevolution.apache.xpath.patterns.NodeTest

m_name, m_whatToShow, SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, WILD

Fields inherited from interface org.loboevolution.apache.xml.dtm.DTMIterator

FILTER_ACCEPT, FILTER_SKIP

Method Summary

Modifier and Type	Method	Description
boolean	deepEquals(Expression expr)	Compare this object with another object and see if they are equal, include the sub heararchy.
int	getAxis()	Returns the axis being iterated, if it is known.
protected int	getNextNode()	Get the next node via getNextXXX.
void	setRoot(int context, Object environment)	Reset the root node of the DTMIterator, overriding the value specified when it was created.

Methods inherited from class org.loboevolution.apache.xpath.axes.ChildTestIterator

cloneWithReset, detach

Methods inherited from class org.loboevolution.apache.xpath.axes.BasicTestIterator

nextNode

Methods inherited from class org.loboevolution.apache.xpath.axes.LocPathIterator

allowDetachToRelease, asIterator, asNode, bool, callVisitors, execute, getAnalysisBits, getCurrentNode, getCurrentPos, getDTM, getDTMManager, getExpandEntityReferences, getIsTopLevel, getLastPos, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, incrementCurrentPos, isDocOrdered, isFresh, item, previousNode, reset, returnNextNode, runTo, setCurrentPos, setIsTopLevel, setShouldCacheNodes

Methods inherited from class org.loboevolution.apache.xpath.axes.PredicatedNodeTest

acceptNode, callPredicateVisitors, canTraverseOutsideSubtree, clone, countProximityPosition, getPredicate, getPredicateCount, getProximityPosition, getProximityPosition, getProximityPosition, initPredicateInfo, initProximityPosition, isReverseAxes, nodeToString, resetProximityPositions, setLocPathIterator, setPredicateCount

Methods inherited from class org.loboevolution.apache.xpath.patterns.NodeTest

calcScore, execute, execute, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow

Methods inherited from class org.loboevolution.apache.xpath.Expression

assertion, error, execute, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.loboevolution.apache.xml.dtm.DTMIterator

clone

Field Details

m_axis

protected int m_axis

The traversal axis from where the nodes will be filtered.

Method Details

setRoot

public void setRoot(int context,
 Object environment)

Reset the root node of the DTMIterator, overriding the value specified when it was created. Note the root node is not the root node of the document tree, but the context node from where the iteration begins.

Specified by:

setRoot in interface DTMIterator

Overrides:

setRoot in class ChildTestIterator

Parameters:

context - int Handle of the context node.

environment - The environment object. The environment in which this iterator operates, which should provide:

a node (the context node... same value as "root" defined below)

a pair of non-zero positive integers (the context position and the context size)

a set of variable bindings

a function library

the set of namespace declarations in scope for the expression.

At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.

getNextNode

protected int getNextNode()

Get the next node via getNextXXX. Bottlenecked for derived class override.

Overrides:

getNextNode in class ChildTestIterator

Returns:

The next node on the axis, or DTM.NULL.

getAxis

public int getAxis()

Returns the axis being iterated, if it is known.

Specified by:

getAxis in interface DTMIterator

Overrides:

getAxis in class ChildTestIterator

Returns:

Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.

deepEquals

public boolean deepEquals(Expression expr)

Compare this object with another object and see if they are equal, include the sub heararchy.

Overrides:

deepEquals in class PredicatedNodeTest

Parameters:

expr - Another expression object.

Returns:

true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.