public final class ContextMappingIterator extends java.lang.Object implements SequenceIterator
This is related to the MappingIterator
class: it differs in that it
sets each item being processed as the context item
SequenceIterator.Property
Constructor and Description |
---|
ContextMappingIterator(ContextMappingFunction action,
XPathContext context)
Construct a ContextMappingIterator that will apply a specified ContextMappingFunction to
each Item returned by the base iterator.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
Item |
next()
Get the next item in the sequence.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachOrFail, getProperties, materialize
public ContextMappingIterator(ContextMappingFunction action, XPathContext context)
action
- the mapping function to be appliedcontext
- the processing context. The mapping function is applied to each item returned
by context.getCurrentIterator() in turn.public Item next() throws XPathException
SequenceIterator
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic void close()
SequenceIterator
For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.
Closing an iterator is important 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 java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SequenceIterator
Copyright (c) 2004-2020 Saxonica Limited. All rights reserved.