|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.ValueTailIterator<T>
public class ValueTailIterator<T extends Item>
ValueTailIterator iterates over a base sequence starting at an element other than the first. It is used in the case where the base sequence is "grounded", that is, it exists in memory and supports efficient direct addressing.
Field Summary |
---|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Constructor Summary | |
---|---|
ValueTailIterator(GroundedValue<T> base,
int start)
Construct a ValueTailIterator |
Method Summary | |
---|---|
void |
close()
Close the iterator. |
T |
current()
Get the current value in the sequence (the one returned by the most recent call on next()). |
ValueTailIterator<T> |
getAnother()
Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence. |
int |
getProperties()
Get properties of this iterator, as a bit-significant integer. |
boolean |
hasNext()
Determine whether there are more items to come. |
GroundedValue<T> |
materialize()
Return a Value containing all the items in the sequence returned by this SequenceIterator. |
T |
next()
Get the next item in the sequence. |
int |
position()
Get the current position. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ValueTailIterator(GroundedValue<T> base, int start)
base
- The items to be filteredstart
- The position of the first item to be included (zero-based)Method Detail |
---|
public T next() throws XPathException
SequenceIterator
next
in interface SequenceIterator<T extends Item>
XPathException
- if an error occurs retrieving the next itempublic T current()
SequenceIterator
current
in interface SequenceIterator<T extends Item>
public int position()
SequenceIterator
This method does not change the state of the iterator.
position
in interface SequenceIterator<T extends Item>
public boolean hasNext()
LookaheadIterator
SequenceIterator.LOOKAHEAD
hasNext
in interface LookaheadIterator<T extends Item>
public void close()
SequenceIterator
(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<T extends Item>
public ValueTailIterator<T> getAnother() throws XPathException
SequenceIterator
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.
getAnother
in interface SequenceIterator<T extends Item>
XPathException
- if any error occurspublic GroundedValue<T> materialize() throws XPathException
materialize
in interface GroundedIterator<T extends Item>
XPathException
- if an error occurs evaluating the sequencepublic int getProperties()
getProperties
in interface SequenceIterator<T extends Item>
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |