JCasIterable (Apache uimaFIT 2.0.0 User-Level API Documentation)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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).

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

Methods
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

- 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>

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012–2013 The Apache Software Foundation. All rights reserved.