|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface UimaContextAdmin
Admin interface to the UIMA Context. Developer code should only use the UimaContext
interface. The methods on this interface are for the framework's use only. *
| Method Summary | |
|---|---|
UimaContextAdmin |
createChild(String aContextName,
Map<String,String> aSofaMappings)
Creates a UimaContext that is a child of this UimaContext. |
void |
defineCasPool(int aSize,
Properties aPerformanceTuningSettings,
boolean aSofaAware)
Defines the CAS pool that this UimaContext must support. |
ComponentInfo |
getComponentInfo()
Gets the ComponentInfo object for this component, which can be passed to CAS.setCurrentComponentInfo(ComponentInfo). |
ConfigurationManager |
getConfigurationManager()
Gets the ConfigurationManager instance used by this UimaContext to resolve configuration parameter resource accesses. |
AnalysisEngineManagement |
getManagementInterface()
Gets an object that can be used to do monitoring or management of this AnalysisEngine. |
String |
getQualifiedContextName()
Gets the fully-qualified name of this context. |
ResourceManager |
getResourceManager()
Gets the ResourceManager instance used by this UimaContext to resolve external resource accesses. |
UimaContextAdmin |
getRootContext()
Gets the Root Context for this Resource. |
Map<String,String> |
getSofaMap()
Gets an unmodifiable Map containing the mapping of component sofa name to absolute sofa ID. |
String |
getUniqueName()
Returns a UUID-like unique name of this component. |
void |
initializeRoot(Logger aLogger,
ResourceManager aResourceManager,
ConfigurationManager aConfigurationManager)
Initializes a root UimaContext. |
void |
returnedCAS(AbstractCas aCAS)
Called internally by the framework whenever the AnalysisComponent returns a CAS from its next() method or calls cas.release(). |
void |
setLogger(Logger aLogger)
Sets the Logger for this UimaContext. |
void |
setProcessTrace(ProcessTrace aProcessTrace)
Sets the current ProcessTrace object, which will receive trace events generated by the InstrumentationFacility. |
void |
setSession(Session aSession)
Sets the current session object. |
| Method Detail |
|---|
void initializeRoot(Logger aLogger,
ResourceManager aResourceManager,
ConfigurationManager aConfigurationManager)
aLogger - the logger that will be returned by this UimaContext's UimaContext.getLogger() method.aResourceManager - the ResourceManager that will be used by this UimaContext to locate and access
external resource.aConfigurationManager - the ConfigurationManager that will be used by this UimaContext to access its
configuration parameter settings.
UimaContextAdmin createChild(String aContextName,
Map<String,String> aSofaMappings)
aContextName - a name for the new context, which must be unique with respect to all children of the
parent context.aSofaMappings - mappings from child's sofa name to parent's sofa name. May be null.void setLogger(Logger aLogger)
UIMAFramework.getLogger())
will be used.
aLogger - the logger that will be returned by this UimaContext's UimaContext.getLogger() method.void setProcessTrace(ProcessTrace aProcessTrace)
aProcessTrace - the ProcessTrace object to receive trace eventsResourceManager getResourceManager()
ConfigurationManager getConfigurationManager()
String getQualifiedContextName()
/MyTopLevelAnalysisEngine/MyComponentAnalysisEngine/MyAnnotator/.
void setSession(Session aSession)
UimaContextAdmin getRootContext()
void defineCasPool(int aSize,
Properties aPerformanceTuningSettings,
boolean aSofaAware)
throws ResourceInitializationException
UimaContext.getEmptyCas(Class) may be called.
aSize - the minimum CAS pool size requiredaPerformanceTuningSettings - settings, including initial CAS heap size, for the AEaSofaAware - whether the component that will receive these CASes is sofa aware. This is needed to
determine which view to get. Sofa-aware components get the base view; sofa-unaware
components get the default text sofa view (or whatever is mapped to it).
ResourceInitializationException - if a CAS could not be created.AnalysisEngineManagement getManagementInterface()
ComponentInfo getComponentInfo()
CAS.setCurrentComponentInfo(ComponentInfo).
Map<String,String> getSofaMap()
void returnedCAS(AbstractCas aCAS)
aCAS - the CAS that was returned or releasedString getUniqueName()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||