org.apache.uima.collection
Class CasInitializer_ImplBase

java.lang.Object
  extended by org.apache.uima.resource.Resource_ImplBase
      extended by org.apache.uima.resource.ConfigurableResource_ImplBase
          extended by org.apache.uima.collection.CasInitializer_ImplBase
All Implemented Interfaces:
CasInitializer, ConfigurableResource, Resource

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 XmlDetagger for an example.

@Deprecated
public abstract class CasInitializer_ImplBase
extends ConfigurableResource_ImplBase
implements CasInitializer

Base class for CAS Initializers, which developers should extend with their own CAS Initializer implementation classes.


Field Summary
 
Fields inherited from interface org.apache.uima.resource.Resource
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
 
Constructor Summary
CasInitializer_ImplBase()
          Deprecated.  
 
Method Summary
 void destroy()
          Deprecated. Releases all resources held by this Resource.
 ProcessingResourceMetaData getProcessingResourceMetaData()
          Deprecated. Gets the metadata that describes this CasInitializer.
 void initialize()
          Deprecated. This method is called during initialization, and does nothing by default.
 boolean initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)
          Deprecated. Called by the framework to initialize this CAS Initializer.
 void reconfigure()
          Deprecated. Notifies this CAS Initializer that its configuration parameter settings have been changed.
 void typeSystemInit(TypeSystem arg0)
          Deprecated. Informs this CasInitializer that the CAS TypeSystem has changed.
 
Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
 
Methods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.uima.collection.CasInitializer
initializeCas
 
Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
 
Methods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
 

Constructor Detail

CasInitializer_ImplBase

public CasInitializer_ImplBase()
Deprecated. 
Method Detail

initialize

public boolean initialize(ResourceSpecifier aSpecifier,
                          Map<String,Object> aAdditionalParams)
                   throws ResourceInitializationException
Deprecated. 
Called by the framework to initialize this CAS Initializer. Subclasses should NOT override this method; instead they should override the zero-argument initialize() method and access metadata via the getProcessingResourceMetaData() method. This method is non-final only for legacy reasons.

Specified by:
initialize in interface Resource
Overrides:
initialize in class Resource_ImplBase
Parameters:
aSpecifier - specifies how to create a resource or locate an existing resource service.
aAdditionalParams - a Map containing additional parameters. May be null if 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. Reutrns false if the given ResourceSpecifier is not of an appropriate type for this Resource. If the ResourceSpecifier is 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:
Resource.initialize(org.apache.uima.resource.ResourceSpecifier, java.util.Map)

initialize

public void initialize()
                throws ResourceInitializationException
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.

destroy

public void destroy()
Deprecated. 
Description copied from interface: Resource
Releases all resources held by this Resource.

Specified by:
destroy in interface Resource
Overrides:
destroy in class Resource_ImplBase
See Also:
Resource.destroy()

typeSystemInit

public void typeSystemInit(TypeSystem arg0)
                    throws ResourceInitializationException
Deprecated. 
Description copied from interface: CasInitializer
Informs this CasInitializer that the CAS TypeSystem has changed. The CollectionReader must call this method whenever the CollectionReader's typeSystemInit() method is called.

In this method, the CasInitializer 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.

Specified by:
typeSystemInit in interface CasInitializer
Throws:
ResourceInitializationException - if the type system is not compatible with this CAS Initializer
See Also:
CasObjectProcessor.typeSystemInit(org.apache.uima.cas.TypeSystem)

getProcessingResourceMetaData

public ProcessingResourceMetaData getProcessingResourceMetaData()
Deprecated. 
Description copied from interface: CasInitializer
Gets the metadata that describes this CasInitializer.

Specified by:
getProcessingResourceMetaData in interface CasInitializer
Returns:
an object containing all metadata for this CasInitializer
See Also:
CasProcessor.getProcessingResourceMetaData()

reconfigure

public void reconfigure()
                 throws ResourceConfigurationException
Deprecated. 
Notifies this CAS Initializer that its configuration parameter settings have been changed. By default this method just calls destroy() followed by initialize(). CAS Initializers 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:
reconfigure in interface ConfigurableResource
Overrides:
reconfigure in class ConfigurableResource_ImplBase
Throws:
ResourceConfigurationException - if the configuration is not valid
See Also:
ConfigurableResource_ImplBase.reconfigure()


Copyright © 2006-2010 The Apache Software Foundation. All Rights Reserved.