Class SAX2DTM2.ChildrenIterator


public final class SAX2DTM2.ChildrenIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns all immediate children of a given node

Constructor Summary
Method Summary
 int next()
          Get the next node in the iteration.
 DTMAxisIterator setStartNode(int node)
          Setting start to END should 'close' the iterator, i.e.
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, reset, setRestartable
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public SAX2DTM2.ChildrenIterator()
Method Detail


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

If the iterator is not restartable, this has no effect. %REVIEW% Should it return/throw something in that case, or set current node to END, to indicate request-not-honored?

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


public int next()
Get the next node in the iteration.
The next node handle in the iteration, or END if no more are available.

Copyright 2006 Apache XML Project. All Rights Reserved.