org.apache.xml.dtm.ref.sax2dtm
Class SAX2DTM2.DescendantIterator

java.lang.Object
  extended by org.apache.xml.dtm.ref.DTMAxisIteratorBase
      extended by org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
          extended by org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.DescendantIterator
All Implemented Interfaces:
java.lang.Cloneable, DTMAxisIterator
Direct Known Subclasses:
SAX2DTM2.TypedDescendantIterator
Enclosing class:
SAX2DTM2

public class SAX2DTM2.DescendantIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns the descendants of a given node.


Field Summary
 
Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator
END
 
Constructor Summary
SAX2DTM2.DescendantIterator()
           
 
Method Summary
 int next()
          Get the next node in the iteration.
 DTMAxisIterator reset()
          Reset.
 DTMAxisIterator setStartNode(int node)
          Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
 
Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
gotoMark, setMark
 
Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase
cloneIterator, getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, setRestartable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAX2DTM2.DescendantIterator

public SAX2DTM2.DescendantIterator()
Method Detail

setStartNode

public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Parameters:
node - Sets the root of the iteration.
Returns:
A DTMAxisIterator set to the start of the iteration.

next

public int next()
Get the next node in the iteration.

Returns:
The next node handle in the iteration, or END.

reset

public DTMAxisIterator reset()
Reset.

Specified by:
reset in interface DTMAxisIterator
Overrides:
reset in class DTMAxisIteratorBase
Returns:
A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.


Copyright ? 2005 Apache XML Project. All Rights Reserved.