|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.bytecode.iter.OneToOneMappingIterator
public abstract class OneToOneMappingIterator
Abstract iterator that performs a one-to-one mapping from the items in the input sequence to the items in the output sequence; the mapping operation is defined by the map() action implemented in the subclass.
Field Summary | |
---|---|
protected XPathContext |
context
|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Constructor Summary | |
---|---|
OneToOneMappingIterator()
|
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 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. |
boolean |
hasNext()
Determine whether there are more items to come. |
protected abstract Item |
map(Item baseItem)
Abstract method to be supplied in subclasses to map an item from the input sequence to an item in the output sequence |
Item |
next()
Get the next item in the sequence. |
int |
position()
Get the current position. |
void |
setSequence(SequenceIterator base,
XPathContext context)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected XPathContext context
Constructor Detail |
---|
public OneToOneMappingIterator()
Method Detail |
---|
public void setSequence(SequenceIterator base, XPathContext context)
public boolean hasNext()
LookaheadIterator
SequenceIterator.LOOKAHEAD
hasNext
in interface LookaheadIterator
public Item next() throws XPathException
SequenceIterator
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itemprotected abstract Item map(Item baseItem) throws XPathException
baseItem
- the item in the input (base) sequence
XPathException
public 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
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
XPathException
- if any error occurspublic int getLength() throws XPathException
LastPositionFinder
SequenceIterator.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
XPathException
- if an error occurs evaluating the sequence in order to determine
the number of itemspublic 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |