org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.AncestorIterator

public class DTMDefaultBaseIterators.AncestorIterator extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns the ancestors of a given node in document order. (NOTE! This was changed from the XSLTC code!)
Method Summary
DTMAxisIteratorcloneIterator()
Returns a deep copy of this iterator.
intgetStartNode()
Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
voidgotoMark()
booleanisReverse()
True if this iterator has a reversed axis.
intnext()
Get the next node in the iteration.
DTMAxisIteratorreset()
Resets the iterator to the last start node.
voidsetMark()
DTMAxisIteratorsetStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Method Detail

cloneIterator

public DTMAxisIterator cloneIterator()
Returns a deep copy of this iterator. The cloned iterator is not reset.

Returns: a deep copy of this iterator.

getStartNode

public int getStartNode()
Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Returns: The root node of the iteration.

gotoMark

public void gotoMark()

isReverse

public final boolean isReverse()
True if this iterator has a reversed axis.

Returns: true since this iterator is a reversed axis.

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()
Resets the iterator to the last start node.

Returns: A DTMAxisIterator, which may or may not be the same as this iterator.

setMark

public void setMark()

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.

Copyright B) 2006 Apache XML Project. All Rights Reserved.