|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.uima.resource.Resource_ImplBase
public abstract class Resource_ImplBase
Implementation base class for Resources. 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_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT |
| Constructor Summary | |
|---|---|
Resource_ImplBase()
|
|
| Method Summary | |
|---|---|
void |
destroy()
Releases all resources held by this Resource. |
CasManager |
getCasManager()
Get the CasManager for this Resource. |
Logger |
getLogger()
Gets the Logger that this Resource is currently using. |
ResourceMetaData |
getMetaData()
Gets the metadata that describes this Resource. |
ResourceManager |
getResourceManager()
Gets the ResourceManager 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 this Resource from a ResourceSpecifier. |
void |
setLogger(Logger aLogger)
Sets the Logger that this Resource will use. |
protected void |
setMetaData(ResourceMetaData aMetaData)
Sets the ResourceMetaData object associated with this Resource. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Resource_ImplBase()
| Method Detail |
|---|
public boolean initialize(ResourceSpecifier aSpecifier,
Map<String,Object> aAdditionalParams)
throws ResourceInitializationException
ResourceResource from a ResourceSpecifier. Applications
do not need to call this method. It is called automatically by the ResourceFactory
and cannot be called a second time.
initialize in interface ResourceaSpecifier - 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.
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.
ResourceInitializationException - if a failure occurs during initialization.Resource.initialize(org.apache.uima.resource.ResourceSpecifier,
java.util.Map)public void destroy()
ResourceResource.
destroy in interface ResourceResource.destroy()public ResourceMetaData getMetaData()
ResourceResource.
getMetaData in interface ResourceResource.getMetaData()protected void setMetaData(ResourceMetaData aMetaData)
ResourceMetaData object associated with this Resource.
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.
aMetaData - metadata to assign to this Resourcepublic Logger getLogger()
Resource
getLogger in interface ResourceResource.getLogger()public void setLogger(Logger aLogger)
ResourceUIMAFramework.getLogger())
will be used.
setLogger in interface ResourceaLogger - the logger for this Resource to useResource.setLogger(org.apache.uima.util.Logger)public ResourceManager getResourceManager()
ResourceResourceManager that this Resource uses to locate other Resources.
getResourceManager in interface ResourceResource.getResourceManager()public UimaContext getUimaContext()
Resource
getUimaContext in interface Resourcepublic UimaContextAdmin getUimaContextAdmin()
getUimaContextAdmin in interface Resourcepublic CasManager getCasManager()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||