public class SortedIterator extends java.lang.Object implements SequenceIterator, LastPositionFinder, LookaheadIterator, Sortable
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 |
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
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
|
void |
close()
Close the iterator.
|
int |
compare(int a,
int b)
Compare two items in sorted sequence
(needed to implement the Sortable interface)
|
int |
getLength()
Get the last position (that is, the number of items in the sequence).
|
int |
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(int language)
Set the host language
|
void |
swap(int a,
int b)
Swap two items (needed to implement the Sortable interface)
|
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(int language)
language
- the host language (for example Configuration.XQUERY
)public boolean hasNext()
SequenceIterator.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.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
XPathException
- if an error occurs evaluating the sequence in order to determine
the number of itemspublic 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
public 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.protected void buildArray() throws XPathException
XPathException
- if an error occurs for example in evaluating a sort keypublic int compare(int a, int b)
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.