net.sf.saxon.tree.util

Class Navigator.AxisFilter

java.lang.Object

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SequenceIterator, AxisIterator

Enclosing class:

Navigator

public static class Navigator.AxisFilter
extends java.lang.Object
implements AxisIterator

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NodeInfo	next() Get the next item in the sequence.

Methods inherited from class java.lang.Object

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

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

close, discharge

Constructor Detail

AxisFilter

public AxisFilter(AxisIterator base,
                  NodePredicate 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: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Specified by:

next in interface SequenceIterator

Specified by:

next in interface AxisIterator

Returns:

the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.