net.sf.saxon.om

Interface AtomizedValueIterator

All Superinterfaces:

SequenceIterator

All Known Implementing Classes:

EmptyIterator, EmptyIterator.OfAtomic, EmptyIterator.OfNodes

public interface AtomizedValueIterator
extends SequenceIterator

Interface implemented by an iterator that can deliver atomized results.

This exists to make it possible to iterate over the atomized nodes in a sequence, especially a sequence obtained from the TinyTree, without actually instantiating the nodes themselves.

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Method Summary

Methods

Modifier and Type	Method and Description
AtomizedValueIterator	getAnother() Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.
AtomicSequence	nextAtomizedValue() Deliver the atomic value that is next in the atomized result

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

close, getProperties, next

Method Detail

nextAtomizedValue

AtomicSequence nextAtomizedValue()
                                 throws XPathException

Deliver the atomic value that is next in the atomized result

Returns:

the next atomic value

Throws:

XPathException - if a failure occurs reading or atomizing the next value

getAnother

AtomizedValueIterator getAnother()
                                 throws XPathException

Description copied from interface: SequenceIterator

Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.

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.

Specified by:

getAnother in interface SequenceIterator

Returns:

a SequenceIterator that iterates over the same items, positioned before the first item

Throws:

XPathException - if any error occurs