org.apache.xml.dtm.ref
Class DTMDefaultBaseIterators.RootIterator

java.lang.Object
  |
  +--org.apache.xml.dtm.ref.DTMAxisIteratorBase
        |
        +--org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
              |
              +--org.apache.xml.dtm.ref.DTMDefaultBaseIterators.RootIterator
Direct Known Subclasses:
DTMDefaultBaseIterators.TypedRootIterator, SAX2DTM2.TypedRootIterator

public class DTMDefaultBaseIterators.RootIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns the the root node as defined by the XPath data model for a given node.


Constructor Summary
DTMDefaultBaseIterators.RootIterator()
          Constructor RootIterator
 
Method Summary
 int next()
          Get the next node in the iteration.
 DTMAxisIterator setStartNode(int node)
          Set 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

DTMDefaultBaseIterators.RootIterator

public DTMDefaultBaseIterators.RootIterator()
Constructor RootIterator
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.


Copyright © 2006 Apache XML Project. All Rights Reserved.