org.apache.uima.impl
Class RootUimaContext_impl

java.lang.Object
  extended by org.apache.uima.impl.UimaContext_ImplBase
      extended by org.apache.uima.impl.RootUimaContext_impl
All Implemented Interfaces:
UimaContext, UimaContextAdmin

public class RootUimaContext_impl
extends UimaContext_ImplBase

Implementation of the root UimaContext. UIMA Contexts are arranged in a tree structure corresponding to the nested structure of the components in a CPE or Aggregate AE. The root UimaContext has direct references to shared components such as the ResourceManager and ConfigurationManager. The children UimaContexts reference these through the root.


Field Summary
 
Fields inherited from class org.apache.uima.impl.UimaContext_ImplBase
mCasPoolSize, mMBean, mOutstandingCASes, mQualifiedContextName, mSofaMappings
 
Constructor Summary
RootUimaContext_impl()
           
 
Method Summary
 ConfigurationManager getConfigurationManager()
          Gets the ConfigurationManager instance used by this UimaContext to resolve configuration parameter resource accesses.
 InstrumentationFacility getInstrumentationFacility()
          Gets the InstrumentationFacility to be used within this AnalysisEngine.
 Logger getLogger()
          Gets the Logger to which log output will be sent.
 ResourceManager getResourceManager()
          Gets the ResourceManager used by this UimaContext to locate and access external resources
 UimaContextAdmin getRootContext()
          Get the Root Context
 Session getSession()
          Returns the Session object, which can be used to store data that pertains to a particular client session.
 void initializeRoot(Logger aLogger, ResourceManager aResourceManager, ConfigurationManager aConfigurationManager)
          Initializes a root UimaContext.
 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.
 
Methods inherited from class org.apache.uima.impl.UimaContext_ImplBase
createChild, defineCasPool, getComponentInfo, getConfigParameterNames, getConfigParameterNames, getConfigParameterValue, getConfigParameterValue, getConfigurationGroupNames, getDataPath, getEmptyCas, getManagementInterface, getQualifiedContextName, getResourceAsStream, getResourceAsStream, getResourceFilePath, getResourceFilePath, getResourceObject, getResourceObject, getResourceURI, getResourceURI, getResourceURL, getResourceURL, getSofaMap, getSofaMappings, getUniqueName, makeQualifiedName, mapSofaIDToComponentSofaName, mapToSofaID, returnedCAS
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RootUimaContext_impl

public RootUimaContext_impl()
Method Detail

initializeRoot

public void initializeRoot(Logger aLogger,
                           ResourceManager aResourceManager,
                           ConfigurationManager aConfigurationManager)
Description copied from interface: UimaContextAdmin
Initializes a root UimaContext.

Parameters:
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.

getLogger

public Logger getLogger()
Description copied from interface: UimaContext
Gets the Logger to which log output will be sent. UIMA components should use this facility rather than writing to their own log files (or to stdout).

Returns:
an instance of a logger for use by this annotator.
See Also:
AnnotatorContext.getLogger()

setLogger

public void setLogger(Logger aLogger)
Description copied from interface: UimaContextAdmin
Sets the Logger for this UimaContext. If this method is not called, the default logger (UIMAFramework.getLogger()) will be used.

Parameters:
aLogger - the logger that will be returned by this UimaContext's UimaContext.getLogger() method.

getResourceManager

public ResourceManager getResourceManager()
Gets the ResourceManager used by this UimaContext to locate and access external resources

Returns:
the ResourceManager

getConfigurationManager

public ConfigurationManager getConfigurationManager()
Description copied from interface: UimaContextAdmin
Gets the ConfigurationManager instance used by this UimaContext to resolve configuration parameter resource accesses.

Returns:
the ConfigurationManager instance for this UimaContext

getInstrumentationFacility

public InstrumentationFacility getInstrumentationFacility()
Gets the InstrumentationFacility to be used within this AnalysisEngine.

Returns:
the InstrumentationFacility to be used within this AnalysisEngine

setProcessTrace

public void setProcessTrace(ProcessTrace aProcessTrace)
Sets the current ProcessTrace object, which will receive trace events generated by the InstrumentationFacility.

This method is to be called from the Analysis Engine, not the Annotator, so it is not part of the AnnotatorContext interface.

Parameters:
aProcessTrace - the ProcessTrace object to receive trace events

setSession

public void setSession(Session aSession)
Description copied from interface: UimaContextAdmin
Sets the current session object. A default Session object is created when the UimaContext is created. In a multi-client deployment, the deployment wrapper is responsible for ensuring that an appropriate Session object is installed here prior to invoking components that use this UimaContext.


getSession

public Session getSession()
Description copied from interface: UimaContext
Returns the Session object, which can be used to store data that pertains to a particular client session. All data that must persist across requests must be stored in the Session object and NOT in component instance variables. In some service deployments, a single component instance may serve multiple clients. In that case, the service wrapper may provide a different Session object for each client, and this method would return the appropriate Session object for the component to use for the current call.

Note that Session support is NOT implemented in any of the service wrappers (Vinci, SOAP) currently provided in the UIMA SDK.

Returns:
the current Session object

getRootContext

public UimaContextAdmin getRootContext()
Get the Root Context

Returns:
root context


Copyright © 2012. All Rights Reserved.