net.sf.saxon.expr

Class ValueTailIterator

java.lang.Object

net.sf.saxon.expr.ValueTailIterator

All Implemented Interfaces:

SequenceIterator, GroundedIterator, LookaheadIterator

public class ValueTailIterator
extends java.lang.Object
implements SequenceIterator, GroundedIterator, LookaheadIterator

ValueTailIterator iterates over a base sequence starting at an element other than the first. It is used in the case where the base sequence is "grounded", that is, it exists in memory and supports efficient direct addressing.

Field Summary

Fields inherited from interface net.sf.saxon.om.SequenceIterator

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
ValueTailIterator(GroundedValue base, int start) Construct a ValueTailIterator

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
int	getProperties() Get properties of this iterator, as a bit-significant integer.
GroundedValue	getResidue() Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position.
boolean	hasNext() Determine whether there are more items to come.
GroundedValue	materialize() Return a Value containing all the items in the sequence returned by this SequenceIterator.
Item	next() Get the next item in the sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueTailIterator

public ValueTailIterator(GroundedValue base,
                         int start)

Construct a ValueTailIterator

Parameters:

base - The items to be filtered

start - The position of the first item to be included (zero-based)

Method Detail

next

public Item next()
          throws XPathException

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Specified by:

next in interface SequenceIterator

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:

XPathException - if an error occurs retrieving the next item

hasNext

public boolean hasNext()

Description copied from interface: LookaheadIterator

Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.

This method must not be called unless the result of getProperties() on the iterator includes the bit setting SequenceIterator.LOOKAHEAD

Specified by:

hasNext in interface LookaheadIterator

Returns:

true if there are more items in the sequence

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

(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.)

Specified by:

close in interface SequenceIterator

materialize

public GroundedValue materialize()

Return a Value containing all the items in the sequence returned by this SequenceIterator. This should be an "in-memory" value, not a Closure.

Specified by:

materialize in interface GroundedIterator

Returns:

the corresponding Value

getResidue

public GroundedValue getResidue()
                         throws XPathException

Description copied from interface: GroundedIterator

Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position. This should be an "in-memory" value, not a Closure.

Specified by:

getResidue in interface GroundedIterator

Returns:

the corresponding Value

Throws:

XPathException - in the cases of subclasses (such as the iterator over a MemoClosure) which cause evaluation of expressions while materializing the value.

getProperties

public int getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as 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.