org.apache.xpath.axes
Class ChildTestIterator

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.patterns.NodeTest
              |
              +--org.apache.xpath.axes.PredicatedNodeTest
                    |
                    +--org.apache.xpath.axes.LocPathIterator
                          |
                          +--org.apache.xpath.axes.ChildTestIterator

Direct Known Subclasses:

AttributeIterator, OneStepIterator, OneStepIteratorForward

public class ChildTestIterator

extends LocPathIterator

**For advanced use only** This class implements an optimized iterator for children patterns that have a node test, and possibly a predicate.

See Also:

org.apache.xpath.axes.WalkerFactory#newLocPathIterator, Serialized Form

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

m_lastFetched

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

SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SUPPORTS_PRE_STRIPPING, WILD

Method Summary

DTMIterator	cloneWithReset() Get a cloned Iterator that is reset to the beginning of the query.
int	getAxis() Returns the axis being iterated, if it is known.
int	nextNode() Returns the next node in the set and advances the position of the iterator in the set.
void	setRoot(int context, java.lang.Object environment) Initialize the context values for this expression after it is cloned.

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

allowDetachToRelease, asIterator, asNode, bool, detach, execute, findLastPos, getCachedNodes, getContext, getCurrentContextNode, getCurrentNode, getCurrentPos, getDTM, getDTMManager, getExpandEntityReferences, getFilter, getFoundLast, getIsTopLevel, getLast, getLastPos, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, isDocOrdered, isFresh, isMutable, isNodesetExpr, item, previousNode, reset, runTo, setCurrentContextNode, setCurrentPos, setEnvironment, setIsTopLevel, setItem, setLast, setShouldCacheNodes, size

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

acceptNode, canTraverseOutsideSubtree, clone, fixupVariables, getLocPathIterator, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, initProximityPosition, isReverseAxes, resetProximityPositions, setLocPathIterator, setPredicateCount

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

debugWhatToShow, execute, execute, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow

Methods inherited from class org.apache.xpath.Expression

assertion, error, executeCharsToContentHandler, isStableNumber, num, setSourceLocator, warn, xstr

Methods inherited from class java.lang.Object

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

Method Detail

cloneWithReset

public DTMIterator cloneWithReset()
                           throws java.lang.CloneNotSupportedException

Get a cloned Iterator that is reset to the beginning of the query.

Returns:

A cloned NodeIterator set of the start of the query.

Throws:

java.lang.CloneNotSupportedException -

Overrides:

cloneWithReset in class LocPathIterator

nextNode

public int nextNode()

Returns the next node in the set and advances the position of the iterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Returns:

The next Node in the set being iterated over, or null if there are no more members in that set.

Overrides:

nextNode in class LocPathIterator

setRoot

public void setRoot(int context,
                    java.lang.Object environment)

Initialize the context values for this expression after it is cloned.

Parameters:

execContext - The XPath runtime context for this transformation.

Overrides:

setRoot in class LocPathIterator

getAxis

public int getAxis()

Returns the axis being iterated, if it is known.

Returns:

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

Overrides:

getAxis in class LocPathIterator