Package org.apache.uima.collection
Class CollectionReader_ImplBase
java.lang.Object
org.apache.uima.resource.Resource_ImplBase
org.apache.uima.resource.ConfigurableResource_ImplBase
org.apache.uima.collection.CollectionReader_ImplBase
- All Implemented Interfaces:
BaseCollectionReader,CollectionReader,ConfigurableResource,Resource
public abstract class CollectionReader_ImplBase
extends ConfigurableResource_ImplBase
implements CollectionReader
Base class for Collection Readers, which developers should extend with their own Collection
Reader implementation classes.
-
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()Default implementation of destroy, which callsBaseCollectionReader.close().Deprecated.As of v2.0 CAS Initializers are deprecated.Gets the metadata for this CollectionReader, which was extracted from the descriptor during initialization.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.booleanReturns false.voidNotifies this Collection Reader that its configuration parameter settings have been changed.voidsetCasInitializer(CasInitializer aCasInitializer) Deprecated.As of v2.0 CAS Initializers are deprecated.voidtypeSystemInit(TypeSystem aTypeSystem) Default implementation of typeSystemInit, which calls the CAS Initializer's typeSystemInit method if a CAS Initializer is present.Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, 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.CollectionReader
getNextMethods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValueMethods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
-
Constructor Details
-
CollectionReader_ImplBase
public CollectionReader_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()Default implementation of destroy, which callsBaseCollectionReader.close(). If close throws an IOException, it will be logged.- Specified by:
destroyin interfaceResource- Overrides:
destroyin classResource_ImplBase- See Also:
-
typeSystemInit
Default implementation of typeSystemInit, which calls the CAS Initializer's typeSystemInit method if a CAS Initializer is present.- Specified by:
typeSystemInitin interfaceCollectionReader- Parameters:
aTypeSystem- the CAS TypeSystem- Throws:
ResourceInitializationException- if the type system is not compatible with this Collection Reader- See Also:
-
getProcessingResourceMetaData
Gets the metadata for this CollectionReader, which was extracted from the descriptor during initialization.- Specified by:
getProcessingResourceMetaDatain interfaceBaseCollectionReader- Returns:
- an object containing all metadata for this CasProcessor
- See Also:
-
isConsuming
public boolean isConsuming()Returns false.- Specified by:
isConsumingin interfaceBaseCollectionReader- Returns:
- true if and only if this is a consuming
CollectionReader - See Also:
-
getCasInitializer
Deprecated.As of v2.0 CAS Initializers are deprecated.Gets the CAS initializer associated with this CollectionReader, if one was supplied viasetCasInitializer(CasInitializer).- Specified by:
getCasInitializerin interfaceCollectionReader- Returns:
- the CAS Initializer for this Collection Reader
- See Also:
-
setCasInitializer
Deprecated.As of v2.0 CAS Initializers are deprecated.Stores the CAS initializer in a private field and provides access to it viagetCasInitializer().- Specified by:
setCasInitializerin interfaceCollectionReader- Parameters:
aCasInitializer- the CAS Initializer for this Collection Reader- See Also:
-
reconfigure
Notifies this Collection Reader that its configuration parameter settings have been changed. By default this method just callsdestroy()followed byinitialize(). Collection Readers that have expensive initialization that does not need to be redone whenever configuration parameters change may wish to override this method to provide a more efficient implementation.- Specified by:
reconfigurein interfaceConfigurableResource- Overrides:
reconfigurein classConfigurableResource_ImplBase- Throws:
ResourceConfigurationException- if the configuration is not valid- See Also:
-