org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.PrecedingSiblingIterator

Enclosing Class:
DTMDefaultBaseIterators
Implemented Interfaces:
Cloneable, DTMAxisIterator
Known Direct Subclasses:
DTMDefaultBaseIterators.TypedPrecedingSiblingIterator

public class DTMDefaultBaseIterators.PrecedingSiblingIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns preceding siblings of a given node

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

END

Method Summary

boolean
isReverse()
True if this iterator has a reversed axis.
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

Method Details

isReverse

public boolean isReverse()
True if this iterator has a reversed axis.
Specified by:
isReverse in interface DTMAxisIterator
Overrides:
isReverse in interface DTMAxisIteratorBase
Returns:
true.

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.