net.sf.saxon.evpull
public class SequenceComposer extends Object implements SequenceIterator
Note: this SequenceIterator does not implement the getAnother()
method, which limits its use,
since getAnother()
is needed to support the XPath last()
function.
Constructor Summary | |
---|---|
SequenceComposer(EventIterator iter, PipelineConfiguration pipe)
Create a sequence composer |
Method Summary | |
---|---|
void | close() |
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.
|
static void | main(String[] args)
Main method for testing only |
Item | next()
Get the next item in the sequence. |
int | position()
Get the current position. |
Parameters: iter the underlying event iterator pipe the pipeline configuration
Returns: the current item, the one most recently returned by a call on next(). Returns null if next() has not been called, or if the end of the sequence has been reached.
Since: 8.4
Returns: a SequenceIterator that iterates over the same items, positioned before the first item
Throws: net.sf.saxon.trans.XPathException if any error occurs
Since: 8.4
Returns: the properties of this iterator. This will be some combination of properties such as SequenceComposer, SequenceComposer, and SequenceComposer. 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.
Since: 8.6
Parameters: args not used
Throws: Exception
Returns: the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.
Throws: net.sf.saxon.trans.XPathException if an error occurs retrieving the next item
Since: 8.4
Returns: the current position, the position of the item returned by the most recent call of next(). This is 1 after next() has been successfully called once, 2 after it has been called twice, and so on. If next() has never been called, the method returns zero. If the end of the sequence has been reached, the value returned will always be <= 0; the preferred value is -1.
Since: 8.4