net.sf.saxon.functions

Class Remove.RemoveIterator

java.lang.Object

net.sf.saxon.functions.Remove.RemoveIterator

All Implemented Interfaces:

LastPositionFinder, SequenceIterator

Enclosing class:

Remove

public static class Remove.RemoveIterator
extends Object
implements SequenceIterator, LastPositionFinder

An implementation of SequenceIterator that returns all items except the one at a specified position.

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
Remove.RemoveIterator(SequenceIterator base, int removePosition)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the iterator.
Remove.RemoveIterator	getAnother() Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.
int	getLength() Get the last position (that is, the number of items in the sequence).
int	getProperties() Get properties of this iterator, as a bit-significant integer.
Item	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

Constructor Detail

Remove.RemoveIterator

public Remove.RemoveIterator(SequenceIterator base,
                     int removePosition)

Method Detail

next

public Item next()
          throws XPathException

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().

Specified by:

next in interface SequenceIterator

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.

Throws:

XPathException - if an error occurs retrieving the next item

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)

Specified by:

close in interface SequenceIterator

getLength

public int getLength()
              throws XPathException

Get the last position (that is, the number of items in the sequence). This method is non-destructive: it does not change the state of the iterator. The result is undefined if the next() method of the iterator has already returned null.

Specified by:

getLength in interface LastPositionFinder

Returns:

the number of items in the sequence

Throws:

XPathException - if an error occurs evaluating the sequence in order to determine the number of items

getAnother

public Remove.RemoveIterator getAnother()
                                 throws XPathException

Description copied from interface: SequenceIterator

Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence.

This method allows access to all the items in the sequence without disturbing the current position of the iterator. Internally, its main use is in evaluating the last() function.

This method does not change the state of the iterator.

Some implementations of this method may regenerate the input sequence, creating new nodes with different identity from the original. This is not recommended, but is hard to prevent. This causes no problem for the primary usage of this method to support the last() function, but it has been known to cause trouble in other situations.

Specified by:

getAnother in interface SequenceIterator

Returns:

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

Throws:

XPathException - if any error occurs

getProperties

public int getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.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.