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 Summary
static java.lang.String AEInstanceCount
           
static java.lang.String CasPoolSize
           
 
Method Summary
 void addAbortedCasReferenceId(java.lang.String aCasReferenceId)
           
 void addInputChannel(InputChannel anInputChannel)
           
 void addServiceInfo(ServiceInfo aServiceInfo)
           
 void beginProcess(int msgType)
           
 void cacheClientEndpoint(Endpoint anEndpoint)
           
 void changeState(BaseAnalysisEngineController.ServiceState state)
           
 void collectionProcessComplete(Endpoint anEndpoint)
           
 void dropCAS(org.apache.uima.cas.CAS aCAS)
           
 void dropCAS(java.lang.String aCasReferenceId, boolean dropCacheEntry)
           
 void dropStats(java.lang.String aCasReferenceId, java.lang.String anEndpointName)
           
 void dumpState(java.lang.StringBuffer buffer, java.lang.String lbl1)
           
 void endProcess(int msgType)
           
 void forceTimeoutOnPendingCases(java.lang.String key)
           
 long getAnalysisTime()
           
 AsynchAECasManager getCasManagerWrapper()
           
 ServicePerformance getCasStatistics(java.lang.String aCasReferenceId)
           
 org.apache.uima.UimaContext getChildUimaContext(java.lang.String aDelegateEndpointName)
           
 Endpoint getClientEndpoint()
           
 java.lang.String getComponentName()
           
 ControllerLatch getControllerLatch()
           
 long getCpuTime()
           
 java.util.Map<java.lang.String,java.lang.String> getDeadClientMap()
           
 ErrorHandlerChain getErrorHandlerChain()
           
 EventSubscriber getEventListener()
           
 long getIdleTime()
           
 long getIdleTimeBetweenProcessCalls(int msgType)
           
 int getIndex()
           
 InProcessCache getInProcessCache()
           
 InputChannel getInputChannel()
           
 InputChannel getInputChannel(java.lang.String aQueueName)
           
 java.lang.String getJmxContext()
           
 java.lang.String getJMXDomain()
           
 java.lang.String getKey()
           
 LocalCache getLocalCache()
           
 JmxManagement getManagementInterface()
           
 Monitor getMonitor()
           
 java.lang.String getName()
           
 OutputChannel getOutputChannel()
           
 AnalysisEngineController getParentController()
           
 InputChannel getReplyInputChannel(java.lang.String aDelegateKey)
           
 long getReplyTime()
           
 java.lang.String getServiceEndpointName()
           
 ServiceErrors getServiceErrors()
           
 ServiceInfo getServiceInfo()
           
 ServicePerformance getServicePerformance()
           
 BaseAnalysisEngineController.ServiceState getState()
           
 java.util.Map getStats()
           
 long getTime(java.lang.String aCasReferenceId, java.lang.String anEndpointName)
           
 UimaTransport getTransport(java.lang.String aKey)
           
 UimaTransport getTransport(UimaAsContext aContext, java.lang.String aKey)
           
 UimaEEAdminContext getUimaEEAdminContext()
           
 UimaMessageListener getUimaMessageListener(java.lang.String aDelegateKey)
           
 void handleDelegateLifeCycleEvent(java.lang.String anEndpoint, int aDelegateCount)
           
 void incrementDeserializationTime(long cpuTime)
           
 void incrementSerializationTime(long cpuTime)
           
 void initialize()
           
 void initializeVMTransport(int parentControllerReplyConsumerCount)
           
 boolean isAwaitingCacheCallbackNotification()
           
 boolean isCasMultiplier()
           
 boolean isPrimitive()
           
 boolean isStopped()
          Returns true if the AnalysisEngineController has been (or is in the process of) shutdown.
 boolean isTopLevelComponent()
           
 void notifyListenersWithInitializationStatus(java.lang.Exception e)
           
 void onInitialize()
           
 void process(org.apache.uima.cas.CAS aCas, java.lang.String aCasId)
           
 void process(org.apache.uima.cas.CAS aCAS, java.lang.String aCasReferenceId, Endpoint anEndpoint)
           
 void process(org.apache.uima.cas.CAS aCAS, java.lang.String anInputCasReferenceId, java.lang.String aNewCasReferenceId, java.lang.String newCASProducedBy)
           
 void quiesceAndStop()
           
 void registerVmQueueWithJMX(java.lang.Object o, java.lang.String aName)
           
 void releaseNextCas(java.lang.String aCasReferenceId)
           
 void saveReplyTime(long snapshot, java.lang.String aKey)
           
 void saveTime(long anArrivalTime, java.lang.String aCasReferenceId, java.lang.String anEndpointName)
           
 void sendMetadata(Endpoint anEndpoint)
           
 void setCasManager(AsynchAECasManager aCasManager)
           
 void setDeployDescriptor(java.lang.String aDeployDescriptor)
           
 void setInputChannel(InputChannel anInputChannel)
           
 void setOutputChannel(OutputChannel anOutputChannel)
           
 void setStopped()
          Called to set the state of the AnalysisEngineController to STOPPED.
 void setUimaEEAdminContext(UimaEEAdminContext anAdminContext)
           
 void stop()
           
 void takeAction(java.lang.String anAction, java.lang.String anEndpointName, ErrorContext anErrorContext)
           
 
Methods inherited from interface org.apache.uima.aae.controller.ControllerLifecycle
addControllerCallbackListener, removeControllerCallbackListener, terminate
 

Field Detail

CasPoolSize

static final java.lang.String CasPoolSize
See Also:
Constant Field Values

AEInstanceCount

static final java.lang.String AEInstanceCount
See Also:
Constant Field Values
Method Detail

sendMetadata

void sendMetadata(Endpoint anEndpoint)
                  throws AsynchAEException
Throws:
AsynchAEException

getControllerLatch

ControllerLatch getControllerLatch()

setInputChannel

void setInputChannel(InputChannel anInputChannel)
                     throws java.lang.Exception
Throws:
java.lang.Exception

addInputChannel

void addInputChannel(InputChannel anInputChannel)
                     throws java.lang.Exception
Throws:
java.lang.Exception

getServiceEndpointName

java.lang.String getServiceEndpointName()

handleDelegateLifeCycleEvent

void handleDelegateLifeCycleEvent(java.lang.String anEndpoint,
                                  int aDelegateCount)

takeAction

void takeAction(java.lang.String anAction,
                java.lang.String anEndpointName,
                ErrorContext anErrorContext)

getInputChannel

InputChannel getInputChannel()

getInputChannel

InputChannel getInputChannel(java.lang.String aQueueName)

saveReplyTime

void saveReplyTime(long snapshot,
                   java.lang.String aKey)

getReplyTime

long getReplyTime()

getStats

java.util.Map getStats()

getChildUimaContext

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

dropCAS

void dropCAS(java.lang.String aCasReferenceId,
             boolean dropCacheEntry)

dropCAS

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

getInProcessCache

InProcessCache getInProcessCache()

isPrimitive

boolean isPrimitive()

getMonitor

Monitor getMonitor()

getName

java.lang.String getName()

getComponentName

java.lang.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,
             java.lang.String aCasId)

process

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

process

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

saveTime

void saveTime(long anArrivalTime,
              java.lang.String aCasReferenceId,
              java.lang.String anEndpointName)

getTime

long getTime(java.lang.String aCasReferenceId,
             java.lang.String anEndpointName)

getErrorHandlerChain

ErrorHandlerChain getErrorHandlerChain()

setOutputChannel

void setOutputChannel(OutputChannel anOutputChannel)
                      throws java.lang.Exception
Throws:
java.lang.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(java.lang.String aCasReferenceId,
               java.lang.String anEndpointName)

setUimaEEAdminContext

void setUimaEEAdminContext(UimaEEAdminContext anAdminContext)

getUimaEEAdminContext

UimaEEAdminContext getUimaEEAdminContext()

getJMXDomain

java.lang.String getJMXDomain()

getIndex

int getIndex()

getJmxContext

java.lang.String getJmxContext()

getServicePerformance

ServicePerformance getServicePerformance()

getServiceInfo

ServiceInfo getServiceInfo()

addServiceInfo

void addServiceInfo(ServiceInfo aServiceInfo)

getServiceErrors

ServiceErrors getServiceErrors()

setDeployDescriptor

void setDeployDescriptor(java.lang.String aDeployDescriptor)

cacheClientEndpoint

void cacheClientEndpoint(Endpoint anEndpoint)

getClientEndpoint

Endpoint getClientEndpoint()

getEventListener

EventSubscriber getEventListener()

getManagementInterface

JmxManagement getManagementInterface()

notifyListenersWithInitializationStatus

void notifyListenersWithInitializationStatus(java.lang.Exception e)

getCasStatistics

ServicePerformance getCasStatistics(java.lang.String aCasReferenceId)

isCasMultiplier

boolean isCasMultiplier()

releaseNextCas

void releaseNextCas(java.lang.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(java.lang.String aDelegateKey)

getTransport

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

getTransport

UimaTransport getTransport(java.lang.String aKey)
                           throws java.lang.Exception
Throws:
java.lang.Exception

initializeVMTransport

void initializeVMTransport(int parentControllerReplyConsumerCount)
                           throws java.lang.Exception
Throws:
java.lang.Exception

getReplyInputChannel

InputChannel getReplyInputChannel(java.lang.String aDelegateKey)

getLocalCache

LocalCache getLocalCache()

registerVmQueueWithJMX

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

getParentController

AnalysisEngineController getParentController()

addAbortedCasReferenceId

void addAbortedCasReferenceId(java.lang.String aCasReferenceId)

isAwaitingCacheCallbackNotification

boolean isAwaitingCacheCallbackNotification()

quiesceAndStop

void quiesceAndStop()

forceTimeoutOnPendingCases

void forceTimeoutOnPendingCases(java.lang.String key)

changeState

void changeState(BaseAnalysisEngineController.ServiceState state)

getState

BaseAnalysisEngineController.ServiceState getState()

getDeadClientMap

java.util.Map<java.lang.String,java.lang.String> getDeadClientMap()

getKey

java.lang.String getKey()

dumpState

void dumpState(java.lang.StringBuffer buffer,
               java.lang.String lbl1)


Copyright © 2011. All Rights Reserved.