Interface CollectionReader
- All Superinterfaces:
BaseCollectionReader,ConfigurableResource,Resource
- All Known Implementing Classes:
CollectionReader_ImplBase
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.
-
Field Summary
Fields inherited from interface org.apache.uima.resource.Resource
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 -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.As of v2.0 CAS Initializers are deprecated.voidGets the next element of the collection.voidsetCasInitializer(CasInitializer aCasInitializer) Deprecated.As of v2.0 CAS Initializers are deprecated.voidtypeSystemInit(TypeSystem aTypeSystem) Informs this CollectionReader that the CAS TypeSystem has changed.Methods inherited from interface org.apache.uima.collection.base_cpm.BaseCollectionReader
close, getProcessingResourceMetaData, getProgress, hasNext, isConsumingMethods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValueMethods inherited from interface org.apache.uima.resource.Resource
destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLogger
-
Method Details
-
typeSystemInit
Informs this CollectionReader that the CAS TypeSystem has changed. The CPM calls this method immediately following the call toResource.initialize(ResourceSpecifier,Map), and will call it again whenever the CAS TypeSystem changes.In this method, the CollectionReader should use the
TypeSystemto resolve the names of Type and Features to the actualTypeandFeatureobjects, which can then be used during processing.- Parameters:
aTypeSystem- the CAS TypeSystem- Throws:
ResourceInitializationException- if the type system is not compatible with this Collection Reader
-
getNext
Gets the next element of the collection. The element will be stored in the provided CAS object. If this is a consumingCollectionReader(seeBaseCollectionReader.isConsuming()), this element will also be removed from the collection.- Parameters:
aCAS- the CAS to populate with the next element of the collection- Throws:
UIMA_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
-
getCasInitializer
Deprecated.As of v2.0 CAS Initializers are deprecated.Gets the CAS Initializer that has been assigned to this Collection Reader. Note that CollectionReader implementations are not required to make use of the CAS Initializer - refer to the documentation for your specific Collection Reader.- Returns:
- the CAS Initializer for this Collection Reader
-
setCasInitializer
Deprecated.As of v2.0 CAS Initializers are deprecated.Assigns a CAS Initializer for this Collection Reader to use. Note that CollectionReader implementations are not required to make use of the CAS Initializer - refer to the documentation for your specific Collection Reader.- Parameters:
aCasInitializer- the CAS Initializer for this Collection Reader
-