Package org.apache.uima.resource
Class Resource_ImplBase
- java.lang.Object
-
- org.apache.uima.resource.Resource_ImplBase
-
- All Implemented Interfaces:
Resource
- Direct Known Subclasses:
ASB_impl
,ConfigurableDataResource_impl
,ConfigurableResource_ImplBase
,DataResource_impl
,FileLanguageResource_impl
,ProcessingContainer
,ResourceServiceAdapter
public abstract class Resource_ImplBase extends Object implements Resource
Implementation base class forResource
s. Provides access to resource metadata and the UIMA Context, which in turn provides access to framework facilities such as logging and resource management.
-
-
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 Constructor Description Resource_ImplBase()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
destroy()
Releases all resources held by thisResource
.CasManager
getCasManager()
Get the CasManager for this Resource.Logger
getLogger()
Get the logger for this UIMA framework class.ResourceMetaData
getMetaData()
Gets the metadata that describes thisResource
.RelativePathResolver
getRelativePathResolver(Map<String,Object> aAdditionalParams)
ResourceManager
getResourceManager()
Gets theResourceManager
that this Resource uses to locate other Resources.UimaContext
getUimaContext()
Gets the UIMA Context for this Resource.UimaContextAdmin
getUimaContextAdmin()
Gets the Admin interface to this Resource's UimaContext.boolean
initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)
Initializes thisResource
from aResourceSpecifier
.void
setLogger(Logger aLogger)
Set the logger in the current UimaContext for use by user annotators.protected void
setMetaData(ResourceMetaData aMetaData)
Sets theResourceMetaData
object associated with thisResource
.
-
-
-
Method Detail
-
initialize
public boolean initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
Description copied from interface:Resource
Initializes thisResource
from aResourceSpecifier
. Applications do not need to call this method. It is called automatically by theResourceFactory
and cannot be called a second time.- Specified by:
initialize
in interfaceResource
- Parameters:
aSpecifier
- specifies how to create a resource or locate an existing resource service.aAdditionalParams
- a Map containing additional parameters. May benull
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 theResourceSpecifier
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:
multi-thread safe, given that each instance of this class is only called on one thread, once. The critical parts that update shared information (in shared uima context) are inside a synchronize block
-
destroy
public void destroy()
Description copied from interface:Resource
Releases all resources held by thisResource
.- Specified by:
destroy
in interfaceResource
- See Also:
Resource.destroy()
-
getMetaData
public ResourceMetaData getMetaData()
Description copied from interface:Resource
Gets the metadata that describes thisResource
.- Specified by:
getMetaData
in interfaceResource
- Returns:
- an object containing all metadata for this resource.
- See Also:
Resource.getMetaData()
-
setMetaData
protected void setMetaData(ResourceMetaData aMetaData)
Sets theResourceMetaData
object associated with thisResource
. Any previously existing metadata will be replaced.Resource subclasses should call this method during initialization in order to set the metadata before any calls to
getMetaData()
are made.- Parameters:
aMetaData
- metadata to assign to thisResource
-
getLogger
public Logger getLogger()
Get the logger for this UIMA framework class. Note that this is NOT the user's logger in the UimaContext
-
setLogger
public void setLogger(Logger aLogger)
Set the logger in the current UimaContext for use by user annotators.
-
getResourceManager
public ResourceManager getResourceManager()
Description copied from interface:Resource
Gets theResourceManager
that this Resource uses to locate other Resources.- Specified by:
getResourceManager
in interfaceResource
- Returns:
- the ResourceManager
- See Also:
Resource.getResourceManager()
-
getUimaContext
public UimaContext getUimaContext()
Description copied from interface:Resource
Gets the UIMA Context for this Resource. This can be used to access external resources or facilities such as the Logger.- Specified by:
getUimaContext
in interfaceResource
- Returns:
- the UimaContext for use by this Resource
-
getUimaContextAdmin
public UimaContextAdmin getUimaContextAdmin()
Gets the Admin interface to this Resource's UimaContext.- Specified by:
getUimaContextAdmin
in interfaceResource
- Returns:
- the administrative interface to this Resource's UimaContext
-
getCasManager
public CasManager getCasManager()
Get the CasManager for this Resource. The CasManager manages the creation and pooling of CASes.- Returns:
- the CasManager
-
getRelativePathResolver
public RelativePathResolver getRelativePathResolver(Map<String,Object> aAdditionalParams)
-
-