Package org.apache.uima.aae.controller

Interface AnalysisEngineController

All Superinterfaces:
ControllerLifecycle
All Known Subinterfaces:
AggregateAnalysisEngineController, PrimitiveAnalysisEngineController
All Known Implementing Classes:
AggregateAnalysisEngineController_impl, AnalysisEngineControllerAdapter, BaseAnalysisEngineController, PrimitiveAnalysisEngineController_impl, UimacppServiceController
public interface AnalysisEngineController extends ControllerLifecycle

  • Field Details

  • Method Details

    • sendMetadata

      void sendMetadata(Endpoint anEndpoint) throws AsynchAEException
      Throws:
      AsynchAEException

    • getControllerLatch

      ControllerLatch getControllerLatch()

    • setInputChannel

      void setInputChannel(InputChannel anInputChannel) throws Exception
      Throws:
      Exception

    • addInputChannel

      void addInputChannel(InputChannel anInputChannel) throws Exception
      Throws:
      Exception

    • getServiceEndpointName

      String getServiceEndpointName()

    • handleDelegateLifeCycleEvent

      void handleDelegateLifeCycleEvent(String anEndpoint, int aDelegateCount)

    • takeAction

      void takeAction(String anAction, String anEndpointName, ErrorContext anErrorContext)

    • getInputChannel

      InputChannel getInputChannel()

    • getInputChannel

      InputChannel getInputChannel(String aQueueName)

    • saveReplyTime

      void saveReplyTime(long snapshot, String aKey)

    • getReplyTime

      long getReplyTime()

    • getStats

      Map getStats()

    • getChildUimaContext

      org.apache.uima.UimaContext getChildUimaContext(String aDelegateEndpointName) throws Exception
      Throws:
      Exception

    • dropCAS

      void dropCAS(String aCasReferenceId, boolean dropCacheEntry)

    • dropCAS

      void dropCAS(org.apache.uima.cas.CAS aCAS)

    • getInProcessCache

      InProcessCache getInProcessCache()

    • isPrimitive

      boolean isPrimitive()

    • getMonitor

      Monitor getMonitor()

    • getName

      String getName()

    • getComponentName

      String getComponentName()

    • collectionProcessComplete

      void collectionProcessComplete(Endpoint anEndpoint) throws AsynchAEException
      Throws:
      AsynchAEException

    • isTopLevelComponent

      boolean isTopLevelComponent()

    • initialize

      void initialize() throws AsynchAEException
      Throws:
      AsynchAEException

    • process

      void process(org.apache.uima.cas.CAS aCas, String aCasId)

    • process

      void process(org.apache.uima.cas.CAS aCAS, String anInputCasReferenceId, String aNewCasReferenceId, String newCASProducedBy)

    • process

      void process(org.apache.uima.cas.CAS aCAS, String aCasReferenceId, Endpoint anEndpoint)

    • saveTime

      void saveTime(long anArrivalTime, String aCasReferenceId, String anEndpointName)

    • getTime

      long getTime(String aCasReferenceId, String anEndpointName)

    • getErrorHandlerChain

      ErrorHandlerChain getErrorHandlerChain()

    • setOutputChannel

      void setOutputChannel(OutputChannel anOutputChannel) throws Exception
      Throws:
      Exception

    • getOutputChannel

      OutputChannel getOutputChannel()

    • setCasManager

      void setCasManager(AsynchAECasManager aCasManager)

    • getCasManagerWrapper

      AsynchAECasManager getCasManagerWrapper()

    • stop

      void stop()

    • isStopped

      boolean isStopped()
      Returns true if the AnalysisEngineController has been (or is in the process of) shutdown.
      Returns:
      - true if stopped

    • setStopped

      void setStopped()
      Called to set the state of the AnalysisEngineController to STOPPED. This method does not stop input or output channels.

    • dropStats

      void dropStats(String aCasReferenceId, String anEndpointName)

    • setUimaEEAdminContext

      void setUimaEEAdminContext(UimaEEAdminContext anAdminContext)

    • getUimaEEAdminContext

      UimaEEAdminContext getUimaEEAdminContext()

    • getJMXDomain

      String getJMXDomain()

    • getIndex

      int getIndex()

    • getJmxContext

      String getJmxContext()

    • getServicePerformance

      ServicePerformance getServicePerformance()

    • getServiceInfo

      ServiceInfo getServiceInfo()

    • addServiceInfo

      void addServiceInfo(ServiceInfo aServiceInfo)

    • getServiceErrors

      ServiceErrors getServiceErrors()

    • setDeployDescriptor

      void setDeployDescriptor(String aDeployDescriptor)

    • cacheClientEndpoint

      void cacheClientEndpoint(Endpoint anEndpoint)

    • getClientEndpoint

      Endpoint getClientEndpoint()

    • getEventListener

      EventSubscriber getEventListener()

    • getManagementInterface

      JmxManagement getManagementInterface()

    • notifyListenersWithInitializationStatus

      void notifyListenersWithInitializationStatus(Exception e)

    • getCasStatistics

      ServicePerformance getCasStatistics(String aCasReferenceId)

    • isCasMultiplier

      boolean isCasMultiplier()

    • releaseNextCas

      void releaseNextCas(String aCasReferenceId)

    • getIdleTime

      long getIdleTime()

    • beginProcess

      void beginProcess(int msgType)

    • endProcess

      void endProcess(int msgType)

    • getIdleTimeBetweenProcessCalls

      long getIdleTimeBetweenProcessCalls(int msgType)

    • getCpuTime

      long getCpuTime()

    • getAnalysisTime

      long getAnalysisTime()

    • incrementSerializationTime

      void incrementSerializationTime(long cpuTime)

    • incrementDeserializationTime

      void incrementDeserializationTime(long cpuTime)

    • onInitialize

      void onInitialize()

    • getUimaMessageListener

      UimaMessageListener getUimaMessageListener(String aDelegateKey)

    • getTransport

      UimaTransport getTransport(UimaAsContext aContext, String aKey) throws Exception
      Throws:
      Exception

    • getTransport

      UimaTransport getTransport(String aKey) throws Exception
      Throws:
      Exception

    • initializeVMTransport

      void initializeVMTransport(int parentControllerReplyConsumerCount) throws Exception
      Throws:
      Exception

    • getReplyInputChannel

      InputChannel getReplyInputChannel(String aDelegateKey)

    • getLocalCache

      LocalCache getLocalCache()

    • registerVmQueueWithJMX

      void registerVmQueueWithJMX(Object o, String aName) throws Exception
      Throws:
      Exception

    • getParentController

      AnalysisEngineController getParentController()

    • addAbortedCasReferenceId

      void addAbortedCasReferenceId(String aCasReferenceId)

    • isAwaitingCacheCallbackNotification

      boolean isAwaitingCacheCallbackNotification()

    • quiesceAndStop

      void quiesceAndStop()

    • forceTimeoutOnPendingCases

      void forceTimeoutOnPendingCases(String key)

    • changeState

      void changeState(BaseAnalysisEngineController.ServiceState state)

    • getState

      BaseAnalysisEngineController.ServiceState getState()

    • getDeadClientMap

      Map<String,String> getDeadClientMap()

    • getKey

      String getKey()

    • dumpState

      void dumpState(StringBuffer buffer, String lbl1)