org.apache.xalan.xsltc.dom

Class NthIterator

Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class NthIterator
extends DTMAxisIteratorBase

Authors:
Jacek Ambroziak
Morten Jorgensen

Nested Class Summary

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()
int
next()
DTMAxisIterator
reset()
void
setMark()
void
setRestartable(boolean isRestartable)
DTMAxisIterator
setStartNode(int node)

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()
Specified by:
gotoMark in interface DTMAxisIterator


next

public int next()
Specified by:
next in interface DTMAxisIterator


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()
Specified by:
setMark in interface DTMAxisIterator


setRestartable

public void setRestartable(boolean isRestartable)
Specified by:
setRestartable in interface DTMAxisIterator
Overrides:
setRestartable in interface DTMAxisIteratorBase


setStartNode

public DTMAxisIterator setStartNode(int node)
Specified by:
setStartNode in interface DTMAxisIterator


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