net.sf.saxon.tree.util

Class Navigator.AxisFilter

java.lang.Object

net.sf.saxon.tree.iter.AxisIteratorImpl

net.sf.saxon.tree.util.Navigator.AxisFilter

All Implemented Interfaces:

SequenceIterator, AxisIterator, UnfailingIterator

Enclosing class:

Navigator

public static class Navigator.AxisFilter
extends AxisIteratorImpl

AxisFilter is an iterator that applies a NodeTest filter to the nodes returned by an underlying AxisIterator.

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
AxisFilter(AxisIterator base, NodeTest test) Construct a AxisFilter

Method Summary

Modifier and Type	Method and Description
AxisIterator	getAnother() Get another iterator over the same sequence of items, positioned at the start of the sequence.
NodeInfo	next() Get the next item in the sequence.

Methods inherited from class net.sf.saxon.tree.iter.AxisIteratorImpl

close, getProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AxisFilter

public AxisFilter(AxisIterator base,
                  NodeTest test)

Construct a AxisFilter

Parameters:

base - the underlying iterator that returns all the nodes on a required axis. This must not be an atomizing iterator!

test - a NodeTest that is applied to each node returned by the underlying AxisIterator; only those nodes that pass the NodeTest are returned by the AxisFilter

Method Detail

next

public NodeInfo next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Returns:

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

getAnother

public AxisIterator getAnother()

Description copied from interface: UnfailingIterator

Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.

Returns:

a new iterator over the same sequence