org.apache.xalan.xsltc.dom

Class CurrentNodeListIterator

Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class CurrentNodeListIterator
extends DTMAxisIteratorBase

Iterators of this kind use a CurrentNodeListFilter to filter a subset of nodes from a source iterator. For each node from the source, the boolean method CurrentNodeListFilter.test() is called. All nodes from the source are read into an array upon calling setStartNode() (this is needed to determine the value of last, a parameter to CurrentNodeListFilter.test()). The method getLast() returns the last element after applying the filter.

Authors:
Jacek Ambroziak
Santiago Pericas-Geertsen
Morten Jorgensen

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

END

Constructor Summary

CurrentNodeListIterator(DTMAxisIterator source, boolean docOrder, CurrentNodeListFilter filter, int currentNode, AbstractTranslet translet)
CurrentNodeListIterator(DTMAxisIterator source, CurrentNodeListFilter filter, int currentNode, AbstractTranslet translet)

Method Summary

DTMAxisIterator
cloneIterator()
Returns a deep copy of this iterator.
DTMAxisIterator
forceNaturalOrder()
int
getLast()
Returns the position of the last node within the iteration, as defined by XPath.
void
gotoMark()
boolean
isReverse()
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

CurrentNodeListIterator

public CurrentNodeListIterator(DTMAxisIterator source,
                               boolean docOrder,
                               CurrentNodeListFilter filter,
                               int currentNode,
                               AbstractTranslet translet)


CurrentNodeListIterator

public CurrentNodeListIterator(DTMAxisIterator source,
                               CurrentNodeListFilter filter,
                               int currentNode,
                               AbstractTranslet translet)

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.


forceNaturalOrder

public DTMAxisIterator forceNaturalOrder()


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


gotoMark

public void gotoMark()
Specified by:
gotoMark in interface DTMAxisIterator


isReverse

public boolean isReverse()
Specified by:
isReverse in interface DTMAxisIterator
Overrides:
isReverse in interface DTMAxisIteratorBase

Returns:
true if this iterator has a reversed axis, else false


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.