org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.RootIterator

Enclosing Class:
DTMDefaultBaseIterators
Implemented Interfaces:
Cloneable, DTMAxisIterator
Known Direct 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.

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Constructor Summary

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. 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, reset, setRestartable

Constructor Details

RootIterator

public RootIterator()
Constructor RootIterator

Method Details

next

public int next()
Get the next node in the iteration.
Specified by:
next in interface DTMAxisIterator
Returns:
The next node handle in the iteration, or END.

setStartNode

public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
Specified by:
setStartNode in interface DTMAxisIterator
Parameters:
node - Sets the root of the iteration.
Returns:
A DTMAxisIterator set to the start of the iteration.

Copyright © 2006 Apache XML Project. All Rights Reserved.