|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.SubsequenceIterator
public class SubsequenceIterator
A SubsequenceIterator selects a subsequence of a sequence
Field Summary |
---|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Method Summary | |
---|---|
void |
close()
Close the iterator. |
Item |
current()
Get the current value in the sequence (the one returned by the most recent call on next()). |
SequenceIterator |
getAnother()
Get another iterator to return the same nodes |
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. |
boolean |
hasNext()
Test whether there are any more items available in the sequence |
static SequenceIterator |
make(SequenceIterator base,
int min,
int max)
Static factory method. |
Item |
next()
Get the next item if there is one |
int |
position()
Get the current position. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static SequenceIterator make(SequenceIterator base, int min, int max) throws XPathException
base
- An iteration of the items to be filteredmin
- The position of the first item to be included (base 1)max
- The position of the last item to be included (base 1)
XPathException
public boolean hasNext()
hasNext
in interface LookaheadIterator
public Item next() throws XPathException
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic Item current()
SequenceIterator
current
in interface SequenceIterator
public int position()
SequenceIterator
This method does not change the state of the iterator.
position
in interface SequenceIterator
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
public SequenceIterator getAnother() throws XPathException
getAnother
in interface SequenceIterator
XPathException
- if any error occurspublic 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 getLength() throws XPathException
SequenceIterator.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
XPathException
- if an error occurs evaluating the sequence in order to determine
the number of items
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |