|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.saxon.expr.flwor.ReturnClauseIterator
public class ReturnClauseIterator
This iterator applies the return expression of a FLWOR expression to each of the tuples in a supplied tuple stream, returning the result as an iterator
Field Summary |
---|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Constructor Summary | |
---|---|
ReturnClauseIterator(TuplePull base,
FLWORExpression flwor,
XPathContext context)
Construct a MappingIterator that will apply a specified MappingFunction to each Item returned by the base iterator. |
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. |
int |
getProperties()
Get properties of this iterator, as a bit-significant integer. |
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 ReturnClauseIterator(TuplePull base, FLWORExpression flwor, XPathContext context)
base
- the base iteratorflwor
- the FLWOR expressioncontext
- the XPath dynamic contextMethod Detail |
---|
public Item next() throws XPathException
SequenceIterator
next
in interface SequenceIterator<Item>
XPathException
- if an error occurs retrieving the next itempublic Item current()
SequenceIterator
current
in interface SequenceIterator<Item>
public int position()
SequenceIterator
This method does not change the state of the iterator.
position
in interface SequenceIterator<Item>
public 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<Item>
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.
getAnother
in interface SequenceIterator<Item>
XPathException
- if any error occurspublic int getProperties()
getProperties
in interface SequenceIterator<Item>
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |