public class SortedIterator extends java.lang.Object implements SequenceIterator, LastPositionFinder, LookaheadIterator
SequenceIterator.Property
Modifier and Type | Field and Description |
---|---|
protected SequenceIterator |
base |
protected AtomicComparer[] |
comparators |
protected XPathContext |
context |
protected int |
count |
protected int |
position |
protected SortKeyEvaluator |
sortKeyEvaluator |
protected ObjectToBeSorted[] |
values |
Modifier | Constructor and Description |
---|---|
protected |
SortedIterator() |
|
SortedIterator(XPathContext context,
SequenceIterator base,
SortKeyEvaluator sortKeyEvaluator,
AtomicComparer[] comparators,
boolean createNewContext)
Create a sorted iterator
|
Modifier and Type | Method and Description |
---|---|
protected void |
buildArray()
Create an array holding the items to be sorted and the values of their sort keys
|
int |
getLength()
Get the last position (that is, the number of items in the sequence).
|
java.util.EnumSet<SequenceIterator.Property> |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
Item |
next()
Get the next item, in sorted order
|
void |
setHostLanguage(HostLanguage language)
Set the host language
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, forEachOrFail, materialize
protected SequenceIterator base
protected SortKeyEvaluator sortKeyEvaluator
protected AtomicComparer[] comparators
protected ObjectToBeSorted[] values
protected int count
protected int position
protected XPathContext context
protected SortedIterator()
public SortedIterator(XPathContext context, SequenceIterator base, SortKeyEvaluator sortKeyEvaluator, AtomicComparer[] comparators, boolean createNewContext)
context
- the dynamic XPath evaluation contextbase
- an iterator over the sequence to be sortedsortKeyEvaluator
- an object that allows the n'th sort key for a given item to be evaluatedcomparators
- an array of AtomicComparers, one for each sort key, for comparing sort key valuescreateNewContext
- true if sort keys are computed relative to the item being sorted (as in XSLT but not XQuery)public void setHostLanguage(HostLanguage language)
language
- the host language (for example HostLanguage.XQUERY
)public boolean hasNext()
This method must not be called unless the result of getProperties() on the iterator
includes the bit setting SequenceIterator.Property.LOOKAHEAD
hasNext
in interface LookaheadIterator
public Item next() throws XPathException
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic int getLength() throws XPathException
LastPositionFinder
SequenceIterator.Property.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
XPathException
- if an error occurs evaluating the sequence in order to determine
the number of itemspublic java.util.EnumSet<SequenceIterator.Property> getProperties()
getProperties
in interface SequenceIterator
SequenceIterator.Property.GROUNDED
, SequenceIterator.Property.LAST_POSITION_FINDER
,
and SequenceIterator.Property.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.protected void buildArray() throws XPathException
XPathException
- if an error occurs for example in evaluating a sort keyCopyright (c) 2004-2020 Saxonica Limited. All rights reserved.