public class ReturnClauseIterator extends Object implements SequenceIterator
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
ReturnClauseIterator(TuplePull base,
FLWORExpression flwor,
XPathContext context)
Construct an iterator over the results of the FLWOR expression.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
SequenceIterator |
getAnother()
Get another SequenceIterator that iterates over the same items as the original,
but which is repositioned at the start of the sequence.
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
Item |
next()
Get the next item in the sequence.
|
public ReturnClauseIterator(TuplePull base, FLWORExpression flwor, XPathContext context)
base
- the base iteratorflwor
- the FLWOR expressioncontext
- the XPath dynamic contextpublic Item next() throws XPathException
SequenceIterator
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic 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
SequenceIterator
This 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.
Some implementations of this method may regenerate the input sequence, creating new nodes with different identity from the original. This is not recommended, but is hard to prevent. This causes no problem for the primary usage of this method to support the last() function, but it has been known to cause trouble in other situations.
getAnother
in interface SequenceIterator
XPathException
- if any error occurspublic 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.Copyright (c) 2004-2014 Saxonica Limited. All rights reserved.