Class CasDataInitializer_ImplBase
java.lang.Object
org.apache.uima.resource.Resource_ImplBase
org.apache.uima.resource.ConfigurableResource_ImplBase
org.apache.uima.collection.base_cpm.CasDataInitializer_ImplBase
- All Implemented Interfaces:
CasDataInitializer,ConfigurableResource,Resource
@Deprecated
public abstract class CasDataInitializer_ImplBase
extends ConfigurableResource_ImplBase
implements CasDataInitializer
Deprecated.
As of v2.0, CAS Initializers are deprecated. A component that performs an operation
like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See
org.apache.uima.examples.XmlDetagger for an example.
Base class from which to extend when writing CAS Initializers 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 TypeMethodDescriptionDeprecated.Gets the metadata that describes thisCasDataInitializer.Deprecated.voidDeprecated.This method is called during initialization, and does nothing by default.booleaninitialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Deprecated.Called by the framework to initialize this CAS Initializer.Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValueMethods inherited from class org.apache.uima.resource.Resource_ImplBase
destroy, 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.CasDataInitializer
initializeCasMethods 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, setLogger
-
Constructor Details
-
CasDataInitializer_ImplBase
public CasDataInitializer_ImplBase()Deprecated.
-
-
Method Details
-
initialize
public boolean initialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) throws ResourceInitializationExceptionDeprecated.Called by the framework to initialize this CAS Initializer. Subclasses should 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
Deprecated.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.
-
getProcessingResourceMetaData
Deprecated.- Returns:
- -
- See Also:
-
getCasInitializerMetaData
Deprecated.Description copied from interface:CasDataInitializerGets the metadata that describes thisCasDataInitializer.- Specified by:
getCasInitializerMetaDatain interfaceCasDataInitializer- Returns:
- an object containing all metadata for this CasDataInitializer
-