org.apache.xalan.xsltc.dom

Class KeyIndex.KeyIndexIterator

Enclosing Class:
KeyIndex
Implemented Interfaces:
Cloneable, DTMAxisIterator

public class KeyIndex.KeyIndexIterator
extends MultiValuedNodeHeapIterator

An iterator representing the result of a reference to either the XSLT key function or the XPath id function.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator

MultiValuedNodeHeapIterator.HeapNode

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

END

Method Summary

int
getLast()
Returns the number of nodes in this iterator.
int
getNodeByPosition(int position)
Return the node at the given position.
int
next()
Get the next node in the iteration.
DTMAxisIterator
reset()
Resets the iterator to the last start node.
DTMAxisIterator
setStartNode(int node)
Set context node for the iterator.

Methods inherited from class org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator

cloneIterator, gotoMark, next, reset, setMark, setStartNode

Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase

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

Method Details

getLast

public int getLast()
Returns the number of nodes in this iterator.
Specified by:
getLast in interface DTMAxisIterator
Overrides:
getLast in interface DTMAxisIteratorBase
Returns:
the number of nodes

getNodeByPosition

public int getNodeByPosition(int position)
Return the node at the given position.
Specified by:
getNodeByPosition in interface DTMAxisIterator
Overrides:
getNodeByPosition in interface DTMAxisIteratorBase
Parameters:
position - The position
Returns:
The node at the given position.

next

public int next()
Get the next node in the iteration.
Specified by:
next in interface DTMAxisIterator
Overrides:
next in interface MultiValuedNodeHeapIterator
Returns:
The next node handle in the iteration, or END.

reset

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

setStartNode

public DTMAxisIterator setStartNode(int node)
Set context node for the iterator. This will cause the iterator to reset itself, reevaluate arguments to the function, look up nodes in the input and reinitialize its internal heap.
Specified by:
setStartNode in interface DTMAxisIterator
Overrides:
setStartNode in interface MultiValuedNodeHeapIterator
Parameters:
node - the context node
Returns:
A DTMAxisIterator set to the start of the iteration.

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