net.sf.saxon.om

Class NamespaceIterator

public class NamespaceIterator extends Object implements AxisIterator

This class provides an implementation of the namespace axis over any implementation of the data model. It relies on element nodes to implement the method (int[])
Nested Class Summary
static classNamespaceIterator.NamespaceNodeImpl
Inner class: a model-independent representation of a namespace node
Constructor Summary
NamespaceIterator(NodeInfo element, NodeTest test)
Method Summary
voidadvance()
Get the next item in the sequence.
Itemcurrent()
Get the current item in the sequence.
SequenceIteratorgetAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence
int[]getInScopeNamespaceCodes()
Get a list of in-scope namespace codes.
intgetProperties()
Get properties of this iterator, as a bit-significant integer.
Itemnext()
Get the next item in the sequence.
intposition()
Get the current position

Constructor Detail

NamespaceIterator

public NamespaceIterator(NodeInfo element, NodeTest test)

Method Detail

advance

public void advance()
Get the next item in the sequence.

current

public Item current()
Get the current item in the sequence.

Returns: the current item, that is, the item most recently returned by next()

getAnother

public SequenceIterator getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence

Returns: a new iterator over the same sequence

getInScopeNamespaceCodes

public int[] getInScopeNamespaceCodes()
Get a list of in-scope namespace codes. If an array of namespace codes is needed, without actually constructing the namespace nodes, a caller may create the NamespaceIterator and then call this method. The result is an array of integers, each containing a prefix code in the top half and a uri code in the bottom half. Note that calling this method is destructive: the iterator is consumed and cannot be used again.

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.

next

public Item next()
Get the next item in the sequence.

Returns: the next Item. If there are no more nodes, return null.

position

public int position()
Get the current position

Returns: the position of the current item (the item most recently returned by next()), starting at 1 for the first node