org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM2.PrecedingIterator

public class SAX2DTM2.PrecedingIterator extends InternalAxisIteratorBase

Iterator that returns preceding nodes of a given node. This includes the node set {root+1, start-1}, but excludes all ancestors, attributes, and namespace nodes.

Method Summary
DTMAxisIterator	cloneIterator() Returns a deep copy of this iterator.
void	gotoMark()
boolean	isReverse() True if this iterator has a reversed axis.
int	next() Get the next node in the iteration.
DTMAxisIterator	reset() Resets the iterator to the last start node.
void	setMark()
DTMAxisIterator	setStartNode(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.

gotoMark

public void gotoMark()

isReverse

public 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.