|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.expr.sort.GroupAdjacentIterator
public class GroupAdjacentIterator
A GroupAdjacentIterator iterates over a sequence of groups defined by xsl:for-each-group group-adjacent="x". The groups are returned in order of first appearance.
Each step of this iterator advances to the first item of the next group, leaving the members of that group in a saved list.
| Field Summary |
|---|
| Fields inherited from interface net.sf.saxon.om.SequenceIterator |
|---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
| Constructor Summary | |
|---|---|
GroupAdjacentIterator(SequenceIterator population,
Expression keyExpression,
XPathContext baseContext,
StringCollator collator)
|
|
| Method Summary | |
|---|---|
void |
close()
Close the iterator. |
Item |
current()
Get the current value in the sequence (the one returned by the most recent call on next()). |
SequenceIterator |
getAnother()
Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence. |
Value |
getCurrentGroupingKey()
Get the grouping key of the current group |
int |
getProperties()
Get properties of this iterator, as a bit-significant integer. |
boolean |
hasNext()
Determine whether there are more items to come. |
SequenceIterator |
iterateCurrentGroup()
Get an iterator over the members of the current group, in population order. |
Item |
next()
Get the next item in the sequence. |
int |
position()
Get the current position. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public GroupAdjacentIterator(SequenceIterator population,
Expression keyExpression,
XPathContext baseContext,
StringCollator collator)
throws XPathException
XPathException| Method Detail |
|---|
public Value getCurrentGroupingKey()
GroupIterator
getCurrentGroupingKey in interface GroupIteratorpublic SequenceIterator iterateCurrentGroup()
GroupIterator
iterateCurrentGroup in interface GroupIteratorpublic boolean hasNext()
LookaheadIteratorSequenceIterator.LOOKAHEAD
hasNext in interface LookaheadIterator
public Item next()
throws XPathException
SequenceIterator
next in interface SequenceIteratorXPathException - if an error occurs retrieving the next itempublic Item current()
SequenceIterator
current in interface SequenceIteratorpublic int position()
SequenceIteratorThis method does not change the state of the iterator.
position in interface SequenceIteratorpublic 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 SequenceIterator getAnother()
throws XPathException
SequenceIteratorThis method allows access to all the items in the sequence without disturbing the current position of the iterator. Internally, its main use is in evaluating the last() function.
This method does not change the state of the iterator.
getAnother in interface SequenceIteratorXPathException - if any error occurspublic int getProperties()
getProperties in interface SequenceIteratorSequenceIterator.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.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||