public class ItemMappingIterator extends java.lang.Object implements SequenceIterator, LookaheadIterator, LastPositionFinder
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
ItemMappingIterator(SequenceIterator base,
ItemMappingFunction action)
Construct an ItemMappingIterator that will apply a specified DummyItemMappingFunction to
each Item returned by the base iterator.
|
ItemMappingIterator(SequenceIterator base,
ItemMappingFunction action,
boolean oneToOne)
Construct an ItemMappingIterator that will apply a specified ItemMappingFunction to
each Item returned by the base iterator.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
protected SequenceIterator |
getBaseIterator()
Get the base (input) iterator
|
int |
getLength()
Get the last position (that is, the number of items in the sequence).
|
protected ItemMappingFunction |
getMappingFunction()
Get the mapping function (the function applied to each item in the input sequence
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
boolean |
isOneToOne()
Ask whether this ItemMappingIterator is one-to-one: that is, for every input item, there is
always exactly one output item.
|
Item |
next()
Get the next item in the sequence.
|
void |
setOneToOne(boolean oneToOne)
Say whether this ItemMappingIterator is one-to-one: that is, for every input item, there is
always exactly one output item.
|
public ItemMappingIterator(SequenceIterator base, ItemMappingFunction action)
base
- the base iteratoraction
- the mapping function to be applied.public ItemMappingIterator(SequenceIterator base, ItemMappingFunction action, boolean oneToOne)
base
- the base iteratoraction
- the mapping function to be appliedoneToOne
- true if this iterator is one-to-onepublic void setOneToOne(boolean oneToOne)
oneToOne
- true if this iterator is one-to-onepublic boolean isOneToOne()
protected SequenceIterator getBaseIterator()
protected ItemMappingFunction getMappingFunction()
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 itempublic 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 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.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.