public class FocusTrackingIterator extends java.lang.Object implements FocusIterator, LookaheadIterator, GroundedIterator, LastPositionFinder
Note that when a FocusTrackingIterator is used to wrap a SequenceIterator in order to track the values of position() and current(), it is important to ensure (a) that the SequenceIterator is initially positioned at the start of the sequence, and (b) that all calls on next() to advance the iterator are directed at the FocusTrackingIterator, and not at the wrapped SequenceIterator.
The methods on this class are synchronized in resolution of bug 3927, concerning calls to
last()
when executing asynchronous calls on xsl:result-document
.
These do not make the iterator fully thread-safe; they merely protect it against calls on
getLength()
made in a thread other than the thread that is making successive calls
on next()
.
Modifier and Type | Field and Description |
---|---|
static boolean |
MEMOIZABLE |
static boolean |
MEMOIZE |
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
FocusTrackingIterator(SequenceIterator base) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
Item |
current()
Get the current value in the sequence (the one returned by the
most recent call on next()).
|
int |
getLength()
Get the position of the last item in the sequence.
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
GroundedValue |
getResidue()
Return a GroundedValue containing all the remaining items in the sequence returned by this
SequenceIterator, starting at the current position.
|
int |
getSiblingPosition(NodeInfo node,
NodeTest nodeTest,
int max)
Get the sibling position of a node: specifically, count how many preceding siblings
of a node satisfy the nodetest.
|
SequenceIterator |
getUnderlyingIterator()
Get the underlying iterator
|
boolean |
hasNext()
Determine whether there are more items to come.
|
GroundedValue |
materialize()
Return a GroundedValue containing all the items in the sequence returned by this
SequenceIterator.
|
Item |
next()
Get the next item in the sequence.
|
int |
position()
Get the current position.
|
public static final boolean MEMOIZABLE
public static boolean MEMOIZE
public FocusTrackingIterator(SequenceIterator base)
public SequenceIterator getUnderlyingIterator()
public Item next() throws XPathException
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic Item current()
current
in interface FocusIterator
public int position()
position
in interface FocusIterator
public int getLength() throws XPathException
getLength
in interface LastPositionFinder
getLength
in interface FocusIterator
XPathException
- if a failure occurs reading the sequencepublic boolean hasNext()
SequenceIterator.LOOKAHEAD
hasNext
in interface LookaheadIterator
java.lang.ClassCastException
- if the base iterator does not support lookahead processingpublic GroundedValue materialize() throws XPathException
materialize
in interface GroundedIterator
XPathException
- in the cases of subclasses (such as the iterator over a MemoClosure)
which cause evaluation of expressions while materializing the value.public GroundedValue getResidue() throws XPathException
getResidue
in interface GroundedIterator
XPathException
- in the cases of subclasses (such as the iterator over a MemoClosure)
which cause evaluation of expressions while materializing the value.public void close()
(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.)
close
in interface SequenceIterator
public int getProperties()
getProperties
in interface SequenceIterator
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.public int getSiblingPosition(NodeInfo node, NodeTest nodeTest, int max)
xsl:apply-templates
select="*"
(which selects a set of sibling nodes) is used in conjunction with patterns
such as match="*[position() mod 2 = 1]
, then calculation of the position of one
node in the sequence of siblings can take advantage of the fact that the position of the
immediately preceding sibling is already known.
This optimization was suggested by the late Sebastian Rahtz, one of Saxon's earliest power users, and it is dedicated to his memory.
node
- the starting node, which is assumed to satisfy the node testnodeTest
- the node testmax
- the maximum number of nodes to be countedCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.