Package org.apache.xalan.xsltc.dom
Class SortingIterator
- java.lang.Object
-
- org.apache.xml.dtm.ref.DTMAxisIteratorBase
-
- org.apache.xalan.xsltc.dom.SortingIterator
-
- All Implemented Interfaces:
java.lang.Cloneable,DTMAxisIterator
public final class SortingIterator extends DTMAxisIteratorBase
- Author:
- Jacek Ambroziak, Santiago Pericas-Geertsen, Morten Jorgensen
-
-
Field Summary
-
Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator
END
-
-
Constructor Summary
Constructors Constructor Description SortingIterator(DTMAxisIterator source, NodeSortRecordFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DTMAxisIteratorcloneIterator()Clone aSortingIteratorby cloning its source iterator and then sharing the factory and the array ofNodeSortRecords.intgetLast()Returns the position of the last node within the iteration, as defined by XPath.intgetPosition()voidgotoMark()Restores the current node remembered by setMark().intnext()Get the next node in the iteration.voidsetMark()Remembers the current node for the next call to gotoMark().DTMAxisIteratorsetStartNode(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
getAxis, getNodeByPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, setRestartable
-
-
-
-
Constructor Detail
-
SortingIterator
public SortingIterator(DTMAxisIterator source, NodeSortRecordFactory factory)
-
-
Method Detail
-
next
public int next()
Description copied from interface:DTMAxisIteratorGet the next node in the iteration.- Returns:
- The next node handle in the iteration, or END.
-
setStartNode
public DTMAxisIterator setStartNode(int node)
Description copied from interface:DTMAxisIteratorSet start to END should 'close' the iterator, i.e. subsequent call to next() should return END.- Parameters:
node- Sets the root of the iteration.- Returns:
- A DTMAxisIterator set to the start of the iteration.
-
getPosition
public int getPosition()
- Specified by:
getPositionin interfaceDTMAxisIterator- Overrides:
getPositionin classDTMAxisIteratorBase- Returns:
- The position of the current node within the set, as defined by XPath. Note that this is one-based, not zero-based.
-
getLast
public int getLast()
Description copied from class:DTMAxisIteratorBaseReturns 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:
getLastin interfaceDTMAxisIterator- Overrides:
getLastin classDTMAxisIteratorBase- Returns:
- The number of nodes in this iterator (forward) or 1 (reverse).
-
setMark
public void setMark()
Description copied from interface:DTMAxisIteratorRemembers the current node for the next call to gotoMark().
-
gotoMark
public void gotoMark()
Description copied from interface:DTMAxisIteratorRestores the current node remembered by setMark().
-
cloneIterator
public DTMAxisIterator cloneIterator()
Clone aSortingIteratorby cloning its source iterator and then sharing the factory and the array ofNodeSortRecords.- Specified by:
cloneIteratorin interfaceDTMAxisIterator- Overrides:
cloneIteratorin classDTMAxisIteratorBase- Returns:
- a deep copy of this iterator.
-
-