public interface CollectionReader extends BaseCollectionReader, ConfigurableResource
CollectionReader is used to iterate over the elements of a Collection. Iteration
is done using the BaseCollectionReader.hasNext() and getNext(CAS) methods. Each element of the
collection is returned in a CAS.
A consuming CollectionReader is one that removes each element from the
collection as it is read. To find out whether a CollectionReader will consume
elements in this way, call the BaseCollectionReader.isConsuming() method.
Users of a CollectionReader should always close it when they are
finished using it.
CollectionReaders are also ConfigurableResources, and can be
instantiated from descriptors. See
XMLParser.parseCollectionReaderDescription(XMLInputSource) and
UIMAFramework.produceCollectionReader(ResourceSpecifier,Map) for more
information.
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 |
|---|---|
CasInitializer |
getCasInitializer()
Deprecated.
As of v2.0 CAS Initializers are deprecated.
|
void |
getNext(CAS aCAS)
Gets the next element of the collection.
|
void |
setCasInitializer(CasInitializer aCasInitializer)
Deprecated.
As of v2.0 CAS Initializers are deprecated.
|
void |
typeSystemInit(TypeSystem aTypeSystem)
Informs this CollectionReader that the CAS TypeSystem has changed.
|
close, getProcessingResourceMetaData, getProgress, hasNext, isConsuminggetConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValuedestroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLoggervoid typeSystemInit(TypeSystem aTypeSystem) throws ResourceInitializationException
Resource.initialize(ResourceSpecifier,Map), and will call it
again whenever the CAS TypeSystem changes.
In this method, the CollectionReader should use the TypeSystem to resolve the names of
Type and Features to the actual Type and
Feature objects, which can then be used during processing.
aTypeSystem - the CAS TypeSystemResourceInitializationException - if the type system is not compatible with this Collection Readervoid getNext(CAS aCAS) throws IOException, CollectionException
CollectionReader (see BaseCollectionReader.isConsuming()), this
element will also be removed from the collection.aCAS - the CAS to populate with the next element of the collectionUIMA_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 Collection@Deprecated CasInitializer getCasInitializer()
@Deprecated void setCasInitializer(CasInitializer aCasInitializer)
aCasInitializer - the CAS Initializer for this Collection ReaderCopyright © 2006–2015 The Apache Software Foundation. All rights reserved.