Package net.sf.saxon.evpull
Class EventMappingIterator
java.lang.Object
net.sf.saxon.evpull.EventMappingIterator
- All Implemented Interfaces:
EventIterator
,PullEvent
MappingIterator merges a sequence of sequences into a single sequence.
It takes as inputs an iteration, and a mapping function to be
applied to each Item returned by that iteration. The mapping function itself
returns another iteration. The result is an iteration of iterators. To convert this
int a single flat iterator over a uniform sequence of events, the result must be wrapped
in an
EventStackIterator
-
Constructor Summary
ConstructorsConstructorDescriptionEventMappingIterator
(SequenceIterator base, EventMappingFunction action) Construct a MappingIterator that will apply a specified MappingFunction to each Item returned by the base iterator. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iteratorsnext()
Get the next event in the sequence
-
Constructor Details
-
EventMappingIterator
Construct a MappingIterator that will apply a specified MappingFunction to each Item returned by the base iterator.- Parameters:
base
- the base iteratoraction
- the mapping function to be applied
-
-
Method Details
-
next
Description copied from interface:EventIterator
Get the next event in the sequence- Specified by:
next
in interfaceEventIterator
- Returns:
- the next event, or null when the sequence is exhausted. Note that since an EventIterator is itself a PullEvent, this method may return a nested iterator.
- Throws:
XPathException
- if a dynamic evaluation error occurs
-
isFlatSequence
public boolean isFlatSequence()Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators- Specified by:
isFlatSequence
in interfaceEventIterator
- Returns:
- true if the next() method is guaranteed never to return an EventIterator
-