org.apache.xalan.xsltc.dom

Class StepIterator

Implemented Interfaces:
Cloneable, DTMAxisIterator
Known Direct Subclasses:
FilteredStepIterator

public class StepIterator
extends DTMAxisIteratorBase

A step iterator is used to evaluate expressions like "BOOK/TITLE". A better name for this iterator would have been ParentIterator since both "BOOK" and "TITLE" are steps in XPath lingo. Step iterators are constructed from two other iterators which we are going to refer to as "outer" and "inner". Every node from the outer iterator (the one for BOOK in our example) is used to initialize the inner iterator. After this initialization, every node from the inner iterator is returned (in essence, implementing a "nested loop").
Authors:
Jacek Ambroziak
Santiago Pericas-Geertsen
Erwin Bolwidt
Morten Jorgensen

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

END

Constructor Summary

StepIterator(DTMAxisIterator source, DTMAxisIterator iterator)

Method Summary

DTMAxisIterator
cloneIterator()
Returns a deep copy of this iterator.
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

StepIterator

public StepIterator(DTMAxisIterator source,
                    DTMAxisIterator iterator)

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.

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.