Class CasDataCollectionReader_ImplBase
java.lang.Object
org.apache.uima.resource.Resource_ImplBase
org.apache.uima.resource.ConfigurableResource_ImplBase
org.apache.uima.collection.base_cpm.CasDataCollectionReader_ImplBase
- All Implemented Interfaces:
BaseCollectionReader,CasDataCollectionReader,ConfigurableResource,Resource
public abstract class CasDataCollectionReader_ImplBase
extends ConfigurableResource_ImplBase
implements CasDataCollectionReader
Base class from which to extend when writing Collection Readers that use the
CasData
interface to access the CAS.-
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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddestroy()Releases all resources held by thisResource.Gets the metadata that describes thisCasProcesor.voidThis method is called during initialization, and does nothing by default.booleaninitialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Called by the framework to initialize this Collection Reader.booleanGets whether this is a consumingCollectionReader.Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValueMethods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, setMetaData, withContextHolderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.uima.collection.base_cpm.BaseCollectionReader
close, getProgress, hasNextMethods inherited from interface org.apache.uima.collection.base_cpm.CasDataCollectionReader
getCasDataInitializer, getNext, getNext, setCasInitializerMethods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
-
Constructor Details
-
CasDataCollectionReader_ImplBase
public CasDataCollectionReader_ImplBase()
-
-
Method Details
-
initialize
public boolean initialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) throws ResourceInitializationExceptionCalled by the framework to initialize this Collection Reader. Subclasses should generally NOT override this method; instead they should override the zero-argumentinitialize()method and access metadata via thegetProcessingResourceMetaData()method. This method is non-final only for legacy reasons.- Specified by:
initializein interfaceResource- Overrides:
initializein classResource_ImplBase- Parameters:
aSpecifier- specifies how to create a resource or locate an existing resource service.aAdditionalParams- a Map containing additional parameters. May benullif there are no parameters. Each class that implements this interface can decide what additional parameters it supports.- Returns:
- true if and only if initialization completed successfully. Returns false if the given
ResourceSpecifieris not of an appropriate type for this Resource. If theResourceSpecifieris of an appropriate type but is invalid or if some other failure occurs, an exception should be thrown. - Throws:
ResourceInitializationException- if a failure occurs during initialization.- See Also:
-
initialize
This method is called during initialization, and does nothing by default. Subclasses should override it to perform one-time startup logic.- Throws:
ResourceInitializationException- if a failure occurs during initialization.
-
destroy
public void destroy()Description copied from interface:ResourceReleases all resources held by thisResource.- Specified by:
destroyin interfaceResource- Overrides:
destroyin classResource_ImplBase- See Also:
-
getProcessingResourceMetaData
Description copied from interface:BaseCollectionReaderGets the metadata that describes thisCasProcesor.- Specified by:
getProcessingResourceMetaDatain interfaceBaseCollectionReader- Returns:
- an object containing all metadata for this CasProcessor
- See Also:
-
isConsuming
public boolean isConsuming()Description copied from interface:BaseCollectionReaderGets whether this is a consumingCollectionReader. ConsumingCollectionReaders remove each element from theCollectionas it is read.- Specified by:
isConsumingin interfaceBaseCollectionReader- Returns:
- true if and only if this is a consuming
CollectionReader - See Also:
-