net.sf.saxon.om

Class AxisIteratorImpl

public abstract class AxisIteratorImpl extends Object implements AxisIterator

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 NodeInfocurrent
protected intposition
Method Summary
Valueatomize()
Return the atomized value of the current node.
voidclose()
Itemcurrent()
Get the current node in the sequence.
intgetProperties()
Get properties of this iterator, as a bit-significant integer.
CharSequencegetStringValue()
Return the string value of the current node.
AxisIteratoriterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.
booleanmoveNext()
Move to the next node, without returning it.
intposition()
Get the current position

Field Detail

current

protected NodeInfo current

position

protected int position

Method Detail

atomize

public Value atomize()
Return the atomized value of the current node.

Returns: the atomized value.

Throws: NullPointerException if there is no current node

close

public void close()

current

public 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 AxisIteratorImpl, AxisIteratorImpl, and AxisIteratorImpl. 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.

getStringValue

public CharSequence getStringValue()
Return the string value of the current node.

Returns: the string value, as an instance of CharSequence.

Throws: NullPointerException if there is no current node

iterateAxis

public AxisIterator iterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.

Parameters: axis the axis to iterate over, using a constant such as CHILD test a predicate to apply to the nodes before returning them.

moveNext

public boolean moveNext()
Move to the next node, without returning it. Returns true if there is a next node, false if the end of the sequence has been reached. After calling this method, the current node may be retrieved using the current() function.

position

public final int position()
Get the current position

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