org.apache.xalan.xsltc.dom

Class NthIterator

Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class NthIterator
extends DTMAxisIteratorBase

Authors:
Jacek Ambroziak
Morten Jorgensen

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

END

Constructor Summary

NthIterator(DTMAxisIterator source, int n)

Method Summary

DTMAxisIterator
cloneIterator()
Returns a deep copy of this iterator.
int
getLast()
Returns the position of the last node within the iteration, as defined by XPath.
int
getPosition()
void
gotoMark()
Restores the current node remembered by setMark().
int
next()
Get the next node in the iteration.
DTMAxisIterator
reset()
void
setMark()
Remembers the current node for the next call to gotoMark().
void
setRestartable(boolean isRestartable)
Set if restartable.
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.DTMAxisIteratorBase

cloneIterator, getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, setRestartable

Constructor Details

NthIterator

public NthIterator(DTMAxisIterator source,
                   int n)

Method Details

cloneIterator

public DTMAxisIterator cloneIterator()
Returns a deep copy of this iterator. Cloned iterators may not be restartable. The iterator being cloned may or may not become non-restartable as a side effect of this operation.
Specified by:
cloneIterator in interface DTMAxisIterator
Overrides:
cloneIterator in interface DTMAxisIteratorBase
Returns:
a deep copy of this iterator.

getLast

public int getLast()
Returns the position of the last node within the iteration, as defined by XPath. In a forward iterator, I believe this equals the number of nodes which this iterator will yield. In a reverse iterator, I believe it should return 1 (since the "last" is the first produced.) This may be an expensive operation when called the first time, since it may have to iterate through a large part of the document to produce its answer.
Specified by:
getLast in interface DTMAxisIterator
Overrides:
getLast in interface DTMAxisIteratorBase
Returns:
The number of nodes in this iterator (forward) or 1 (reverse).

getPosition

public int getPosition()
Specified by:
getPosition in interface DTMAxisIterator
Overrides:
getPosition in interface DTMAxisIteratorBase
Returns:
The position of the current node within the set, as defined by XPath. Note that this is one-based, not zero-based.

gotoMark

public void gotoMark()
Restores the current node remembered by setMark().
Specified by:
gotoMark in interface DTMAxisIterator

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.

reset

public DTMAxisIterator reset()
Specified by:
reset in interface DTMAxisIterator
Overrides:
reset in interface DTMAxisIteratorBase
Returns:
A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.

setMark

public void setMark()
Remembers the current node for the next call to gotoMark().
Specified by:
setMark in interface DTMAxisIterator

setRestartable

public void setRestartable(boolean isRestartable)
Set if restartable.
Specified by:
setRestartable in interface DTMAxisIterator
Overrides:
setRestartable in interface DTMAxisIteratorBase

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 B) 2004 Apache XML Project. All Rights Reserved.