public class JCasIterable extends Object implements Iterable<org.apache.uima.jcas.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).
NOTE:If any exception is generated while using the iterator generated by
iterator()
, an unchecked IllegalStateException
is thrown!
External resources can be shared between the reader and the analysis engines.
Constructor and Description |
---|
JCasIterable(org.apache.uima.collection.CollectionReaderDescription aReader,
org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)
Iterate over the documents loaded by the collection reader, running the analysis engines on
each one before yielding them.
|
JCasIterable(org.apache.uima.resource.ResourceManager aResMgr,
org.apache.uima.collection.CollectionReaderDescription aReader,
org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)
Iterate over the documents loaded by the collection reader, running the analysis engines on
each one before yielding them.
|
Modifier and Type | Method and Description |
---|---|
JCasIterator |
iterator() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public JCasIterable(org.apache.uima.collection.CollectionReaderDescription aReader, org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)
aReader
- The collection reader for loading documents.aEngines
- The analysis engines for processing documents.public JCasIterable(org.apache.uima.resource.ResourceManager aResMgr, org.apache.uima.collection.CollectionReaderDescription aReader, org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)
aResMgr
- The ResourceManager
used to create the components and the JCas. If this
parameter is null
then ResourceManagerFactory.newResourceManager()
will be used to obtain a resource manager. If a new resource manager was internally
created, it is destroyed at the end of the pipeline.aReader
- The collection reader for loading documents.aEngines
- The analysis engines for processing documents.public JCasIterator iterator()
Copyright © 2012–2022 The Apache Software Foundation. All rights reserved.