public final class DocumentOrderIterator extends java.lang.Object implements SequenceIterator, Sortable
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
DocumentOrderIterator(SequenceIterator base,
ItemOrderComparer comparer)
Iterate over a sequence in document order.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
int |
compare(int a,
int b)
Compare two nodes in document sequence
(needed to implement the Sortable interface)
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
NodeInfo |
next()
Get the next item in the sequence.
|
void |
swap(int a,
int b)
Swap two nodes (needed to implement the Sortable interface)
|
public DocumentOrderIterator(SequenceIterator base, ItemOrderComparer comparer) throws XPathException
base
- the input sequence to be sortedcomparer
- the comparer used for comparing node positionsXPathException
- if the input sequence cannot be evaluatedpublic int compare(int a, int b)
public void swap(int a, int b)
public NodeInfo next() throws XPathException
SequenceIterator
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic int getProperties()
getProperties
in interface SequenceIterator
SequenceIterator.GROUNDED
, SequenceIterator.LAST_POSITION_FINDER
,
and SequenceIterator.LOOKAHEAD
. It is always
acceptable to return the value zero, indicating that there are no known special properties.
It is acceptable for the properties of the iterator to change depending on its state.public void close()
SequenceIterator
(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)
close
in interface SequenceIterator
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.