public interface CasDataCollectionReader extends BaseCollectionReader
CasDataCollectionReader is used to iterate over the elements of a Collection.
Iteration is done using the BaseCollectionReader.hasNext() and getNext() methods. Each element of
the collection is returned as a CasData.PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT| Modifier and Type | Method and Description |
|---|---|
CasDataInitializer |
getCasDataInitializer()
Deprecated.
As of v2.0 CAS Initializers are deprecated.
|
CasData |
getNext()
Gets the next
CasData from this CollectionReader. |
CasData[] |
getNext(int aNumToGet)
Gets multiple
CasData objects from this CasDataCollectionReader. |
void |
setCasInitializer(CasDataInitializer aCasDataInitializer)
Deprecated.
As of v2.0 CAS Initializers are deprecated.
|
close, getProcessingResourceMetaData, getProgress, hasNext, isConsumingdestroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLoggerCasData getNext() throws IOException, CollectionException
CasData from this CollectionReader. If this is a
consuming Collection Reader (see BaseCollectionReader.isConsuming()), this element will also be removed
from the collection.EntityUIMA_IllegalStateException - if there are no more elements left in the collectionIOException - if an I/O failure occursCollectionException - if there is some other problem with reading from the CollectionCasData[] getNext(int aNumToGet) throws IOException, CollectionException
CasData objects from this CasDataCollectionReader.
If this is a consuming Collection Reader (see BaseCollectionReader.isConsuming()), these entities will
also be removed from the collection.aNumToGet - the number of CasData objects to getCasData objects. The length of this array will
be at most aNumToGet, although it may be less (if there are not enough
elements left in the collection).UIMA_IllegalStateException - if there is no more elements in the collectionIOException - if an I/O failure occursCollectionException - if there is some other problem with reading from the Collection@Deprecated CasDataInitializer getCasDataInitializer()
@Deprecated void setCasInitializer(CasDataInitializer aCasDataInitializer)
aCasDataInitializer - the CAS Data Initializer for this Collection ReaderCopyright © 2006–2015 The Apache Software Foundation. All rights reserved.