net.sf.saxon.om

Class AxisIteratorImpl

public abstract class AxisIteratorImpl extends Object implements AxisIterator, AtomizableIterator

A SequenceIterator is used to iterate over a sequence. An AxisIterator is a SequenceIterator that always iterates over a set of nodes, and that throws no exceptions; it also supports the ability to find the last() position, again with no exceptions. This class is an abstract implementation of AxisIterator that is used as a base class for many concrete implementations. The main functionality that it provides is maintaining the current position.
Field Summary
protected Itemcurrent
protected intposition
Method Summary
Itemcurrent()
Get the current node in the sequence.
intgetProperties()
Get properties of this iterator, as a bit-significant integer.
protected booleanisAtomizing()
Determine whether any nodes returned by this iterator will be atomized, in which case the supplier has the option of atomizing them eagerly.
intposition()
Get the current position
voidsetIsAtomizing(boolean atomizing)
Indicate that any nodes returned in the sequence will be atomized.

Field Detail

current

protected Item current

position

protected int position

Method Detail

current

public final Item current()
Get the current node in the sequence.

Returns: the node returned by the most recent call on next()

getProperties

public int getProperties()
Get properties of this iterator, as a bit-significant integer.

Returns: the properties of this iterator. This will be some combination of properties such as GROUNDED, LAST_POSITION_FINDER, and 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.

isAtomizing

protected final boolean isAtomizing()
Determine whether any nodes returned by this iterator will be atomized, in which case the supplier has the option of atomizing them eagerly.

position

public final int position()
Get the current position

Returns: the position of the most recent node returned by next()

setIsAtomizing

public void setIsAtomizing(boolean atomizing)
Indicate that any nodes returned in the sequence will be atomized. This means that if it wishes to do so, the implementation can return the typed values of the nodes rather than the nodes themselves. The implementation is free to ignore this hint.

Parameters: atomizing true if the caller of this iterator will atomize any nodes that are returned, and is therefore willing to accept the typed value of the nodes instead of the nodes themselves.