com.saxonica.ee.bytecode.iter

Class CompiledBlockIterator

java.lang.Object

com.saxonica.ee.bytecode.iter.CompiledBlockIterator

All Implemented Interfaces:

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

public abstract class CompiledBlockIterator
extends java.lang.Object
implements SequenceIterator

Iterate over the instructions in the Block, concatenating the result of each instruction into a single combined sequence.

Field Summary

Fields

Modifier and Type	Field and Description
protected XPathContext	context
protected SequenceIterator	currentIterator
protected int	state

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
CompiledBlockIterator()
CompiledBlockIterator(XPathContext context)

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
XPathContext	getContext()
int	getProperties() Get properties of this iterator, as a bit-significant integer.
abstract Item	next() Get the next item in the sequence.
void	setContext(XPathContext context)

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

forEachOrFail, materialize

Field Detail

state

protected int state

context

protected XPathContext context

currentIterator

protected SequenceIterator currentIterator

Constructor Detail

CompiledBlockIterator

public CompiledBlockIterator()

CompiledBlockIterator

public CompiledBlockIterator(XPathContext context)

Method Detail

getContext

public XPathContext getContext()

setContext

public void setContext(XPathContext context)

next

public abstract Item next()
                   throws XPathException

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator

Returns:

the next item, or null if there are no more items.

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.

For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.

Closing an iterator is important 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 java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface SequenceIterator

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.