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
Method Summary
voidadvance()
Get the next item in the sequence.
Valueatomize()
Return the atomized value of the current node.
voidclose()
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
static int[]getInScopeNamespaceCodes(NodeInfo element)
Get a list of in-scope namespace codes.
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.
static AxisIteratormakeIterator(NodeInfo element, NodeTest test)
Factory method to create an iterator over the in-scope namespace nodes
booleanmoveNext()
Move to the next node, without returning it.
Itemnext()
Get the next item in the sequence.
intposition()
Get the current position

Method Detail

advance

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

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 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 static int[] getInScopeNamespaceCodes(NodeInfo element)
Get a list of in-scope namespace codes. If an array of namespace codes is needed, without actually constructing the namespace nodes, this factory method can be used directly. 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.

Parameters: element the element whose nodes are required

Returns: the list of in scope namespaces

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 NamespaceIterator, NamespaceIterator, and NamespaceIterator. 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.

Throws: NullPointerException if there is no current node

makeIterator

public static AxisIterator makeIterator(NodeInfo element, NodeTest test)
Factory method to create an iterator over the in-scope namespace nodes

Parameters: element the node whose namespaces are required test used to filter the returned nodes

Returns: an iterator over the namespace nodes that satisfy the test

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.

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