net.sf.saxon.expr

Class FilterIterator.Leading

java.lang.Object

net.sf.saxon.expr.FilterIterator

net.sf.saxon.expr.FilterIterator.Leading

All Implemented Interfaces:

SequenceIterator

Enclosing class:

FilterIterator

public static final class FilterIterator.Leading
extends FilterIterator

Subclass to support the extension function saxon:leading, which terminates the iteration at the first item whose predicate is false

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.expr.FilterIterator

FilterIterator.Leading, FilterIterator.NonNumeric

Field Summary

Fields inherited from class net.sf.saxon.expr.FilterIterator

base, filter, filterContext

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

ATOMIZABLE, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
Leading(SequenceIterator base, Expression filter, XPathContext context)

Method Summary

Modifier and Type	Method and Description
SequenceIterator	getAnother() Get another iterator to return the same nodes
protected Item	getNextMatchingItem() Get the next node that matches the filter predicate if there is one
protected boolean	matches() Determine whether the context item matches the filter predicate

Methods inherited from class net.sf.saxon.expr.FilterIterator

current, getProperties, next, position, setFilterIsSingletonBoolean

Methods inherited from class java.lang.Object

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

Constructor Detail

Leading

public Leading(SequenceIterator base,
               Expression filter,
               XPathContext context)

Method Detail

matches

protected boolean matches()
                   throws XPathException

Determine whether the context item matches the filter predicate

Overrides:

matches in class FilterIterator

Throws:

XPathException

getNextMatchingItem

protected Item getNextMatchingItem()
                            throws XPathException

Get the next node that matches the filter predicate if there is one

Overrides:

getNextMatchingItem in class FilterIterator

Throws:

XPathException

getAnother

public SequenceIterator getAnother()
                            throws XPathException

Get another iterator to return the same nodes

Specified by:

getAnother in interface SequenceIterator

Overrides:

getAnother in class FilterIterator

Returns:

a SequenceIterator that iterates over the same items, positioned before the first item

Throws:

XPathException - if any error occurs