org.apache.xpath.axes
Class DescendantIterator

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.DescendantIterator

public class DescendantIterator

extends LocPathIterator

**For advanced use only** This class implements an optimized iterator for descendant, descendant-or-self, or "//foo" patterns.

See Also:

WalkerFactory.newLocPathIterator(org.apache.xpath.compiler.Compiler, int), 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, SHOW_NAMESPACE, SUPPORTS_PRE_STRIPPING, WILD

Constructor Summary

DescendantIterator(Compiler compiler, int opPos, int analysis)
Create a DescendantIterator object.

Method Summary

NodeIterator	cloneWithReset() Get a cloned Iterator that is reset to the beginning of the query.
Node	nextNode() Returns the next node in the set and advances the position of the iterator in the set.

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

addToWaitList, canTraverseOutsideSubtree, clone, detach, execute, getCachedNodes, getContext, getCurrentContextNode, getCurrentNode, getCurrentPos, getDOMHelper, getExpandEntityReferences, getFilter, getFirstWalker, getFoundLast, getIsTopLevel, getLast, getLastPos, getLastUsedWalker, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, initContext, isFresh, item, previousNode, removeFromWaitList, reset, runTo, setCurrentContextNode, setCurrentPos, setIsTopLevel, setLast, setLastUsedWalker, setShouldCacheNodes, size

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

acceptNode, getLocPathIterator, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, initProximityPosition, isReverseAxes, resetProximityPositions, setLocPathIterator, setPredicateCount

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

debugWhatToShow, execute, getDefaultScore, getLocalName, getNamespace, initNodeTest, initNodeTest

Methods inherited from class org.apache.xpath.Expression

assert, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

DescendantIterator

public DescendantIterator(Compiler compiler,
                          int opPos,
                          int analysis)
                   throws TransformerException

Create a DescendantIterator object.

Parameters:

compiler - A reference to the Compiler that contains the op map.

opPos - The position within the op map, which contains the location path expression for this itterator.

Throws:

TransformerException -

Method Detail

cloneWithReset

public NodeIterator 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 Node nextNode()
              throws DOMException

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.

Throws:

DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

Overrides:

nextNode in class LocPathIterator