public class GroupBreakingIterator extends java.lang.Object implements LookaheadIterator, GroupIterator
Constructor and Description |
---|
GroupBreakingIterator(Expression select,
Function breakWhen,
XPathContext baseContext) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
void |
discharge()
Calling this method instructs the iterator to release any resources it holds, while still
remaining able to deliver the remaining items in the sequence.
|
AtomicSequence |
getCurrentGroupingKey()
Get the grouping key of the current group
|
ManualGroupIterator |
getSnapShot(XPathContext context)
Get a sequence which is a snapshot of this sequence at the current position
|
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.
|
boolean |
supportsHasNext()
Ask whether the hasNext() method can be called.
|
public GroupBreakingIterator(Expression select, Function breakWhen, XPathContext baseContext) throws XPathException
XPathException
public AtomicSequence getCurrentGroupingKey()
GroupIterator
getCurrentGroupingKey
in interface GroupIterator
public SequenceIterator iterateCurrentGroup()
GroupIterator
iterateCurrentGroup
in interface GroupIterator
public boolean supportsHasNext()
LookaheadIterator
supportsHasNext
in interface LookaheadIterator
LookaheadIterator.hasNext()
method is availablepublic boolean hasNext()
LookaheadIterator
This method must not be called unless the result of LookaheadIterator.supportsHasNext()
is true.
hasNext
in interface LookaheadIterator
public Item next()
SequenceIterator
next
in interface SequenceIterator
public void close()
SequenceIterator
For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.
Closing an iterator is important 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.
Closing an iterator is not necessary if the iterator is read to completion: if a call
on SequenceIterator.next()
returns null, the iterator will be closed automatically. An explicit
call on SequenceIterator.close()
is needed only when iteration is abandoned prematurely.
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SequenceIterator
public void discharge()
SequenceIterator
SequenceIterator.close()
will be called when no more items are needed.discharge
in interface SequenceIterator
public ManualGroupIterator getSnapShot(XPathContext context)
GroupIterator
getSnapShot
in interface GroupIterator
context
- the XPath contextCopyright (c) 2004-2022 Saxonica Limited. All rights reserved.