org.apache.uima.fit.pipeline

Class JCasIterable

java.lang.Object

org.apache.uima.fit.pipeline.JCasIterable

All Implemented Interfaces:

Iterable<JCas>

public class JCasIterable
extends Object
implements Iterable<JCas>

A class implementing iteration over a the documents of a collection. Each element in the Iterable is a JCas containing a single document. The documents have been loaded by the CollectionReader and processed by the AnalysisEngine (if any).

External resources can be shared between the reader and the analysis engines.

Constructor Summary

Constructors

Constructor and Description
JCasIterable(CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each one before yielding them.

Method Summary

Modifier and Type	Method and Description
JCasIterator	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

JCasIterable

public JCasIterable(CollectionReaderDescription aReader,
                    AnalysisEngineDescription... aEngines)

Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each one before yielding them. When created with this constructor, analysis engines by default receive a collectionProcessComplete call when all documents have been read from the reader and all components get destroyed.

Parameters:

aReader - The CollectionReader for loading documents.

aEngines - The AnalysisEngines for processing documents.

Method Detail

iterator

public JCasIterator iterator()

Specified by:

iterator in interface Iterable<JCas>