JCasIterator (Apache uimaFIT 2.0.0 User-Level API Documentation)

java.lang.Object
- org.apache.uima.fit.pipeline.JCasIterator

All Implemented Interfaces:

Iterator<JCas>
```
public class JCasIterator
extends Object
implements Iterator<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
`JCasIterator(CollectionReader aReader, AnalysisEngine... aEngines)` Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each one before yielding them.
`JCasIterator(CollectionReader aReader, TypeSystemDescription aTypeSystemDescription)` Iterate over the documents loaded by the CollectionReader.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`collectionProcessComplete()`
`void`	`destroy()`
`boolean`	`hasNext()`
`boolean`	`isSelfComplete()`
`boolean`	`isSelfDestroy()`
`JCas`	`next()`
`void`	`remove()`
`void`	`setSelfComplete(boolean aSelfComplete)` Send a collectionProcessComplete call to analysis engines when the reader has no further CASes to produce.
`void`	`setSelfDestroy(boolean aSelfDestroy)` Send a destroy call to analysis engines when the reader has no further CASes to produce or if an error occurs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JCasIterator
```
public JCasIterator(CollectionReader aReader,
            AnalysisEngine... aEngines)
             throws CASException,
                    ResourceInitializationException
```
    Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each one before yielding them. By default, components get no lifecycle events, such as collectionProcessComplete or destroy when this constructor is used.
    
    Parameters:
    aReader - The CollectionReader for loading documents.
    aEngines - The AnalysisEngines for processing documents.
    
    Throws:
    
    CASException
    
    ResourceInitializationException
  - JCasIterator
```
public JCasIterator(CollectionReader aReader,
            TypeSystemDescription aTypeSystemDescription)
             throws CASException,
                    ResourceInitializationException
```
    Iterate over the documents loaded by the CollectionReader. (Uses an JCasAnnotatorAdapter to create the document JCas.) By default, components get no lifecycle events, such as collectionProcessComplete or destroy when this constructor is used.
    
    Parameters:
    aReader - The CollectionReader for loading documents.
    aTypeSystemDescription - a type system description
    
    Throws:
    
    CASException
    
    ResourceInitializationException
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<JCas>
  - next
```
public JCas next()
```
    Specified by:
    
    next in interface Iterator<JCas>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<JCas>
  - collectionProcessComplete
```
public void collectionProcessComplete()
                               throws AnalysisEngineProcessException
```
    Throws:
    
    AnalysisEngineProcessException
  - destroy
```
public void destroy()
```
  - isSelfComplete
```
public boolean isSelfComplete()
```
  - setSelfComplete
```
public void setSelfComplete(boolean aSelfComplete)
```
    Send a collectionProcessComplete call to analysis engines when the reader has no further CASes to produce.
  - isSelfDestroy
```
public boolean isSelfDestroy()
```
  - setSelfDestroy
```
public void setSelfDestroy(boolean aSelfDestroy)
```
    Send a destroy call to analysis engines when the reader has no further CASes to produce or if an error occurs.

Class JCasIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JCasIterator

JCasIterator

Method Detail

hasNext

next

remove

collectionProcessComplete

destroy

isSelfComplete

setSelfComplete

isSelfDestroy

setSelfDestroy