Package org.apache.uima.aae.handler

Class HandlerBase

java.lang.Object

org.apache.uima.aae.handler.HandlerBase

All Implemented Interfaces:

Handler

Direct Known Subclasses:

MetadataRequestHandler_impl, MetadataResponseHandler_impl, ProcessRequestHandler_impl, ProcessResponseHandler

public abstract class HandlerBase
extends java.lang.Object
implements Handler

Constructor Summary

Constructors

Constructor	Description
HandlerBase(java.lang.String aName)

Method Summary

Modifier and Type	Method	Description
protected void	aggregateDelegateStats(MessageContext aMessageContext, java.lang.String aCasReferenceId)
protected void	computeStats(MessageContext aMessageContext, java.lang.String aCasReferenceId)
void	delegate(MessageContext aMessageContext)
AnalysisEngineController	getController()
Handler	getDelegate()
java.lang.String	getName()
void	handle(java.lang.Object anObjectToHandle)
void	handle(java.lang.Object anObjectToHandle, java.lang.String expectedOutputType)
boolean	hasDelegateHandler()
void	invokeProcess(org.apache.uima.cas.CAS aCAS, java.lang.String anInputCasReferenceId, java.lang.String aNewCasReferenceId, MessageContext aMessageContext, java.lang.String aNewCasProducedBy)
boolean	isHandlerForMessage(MessageContext aMessageContext, int anExpectedMessageType, int anExpectedCommand)
static ErrorContext	populateErrorContext(MessageContext aMessageCtx)
void	removeDelegate(java.lang.String aHandlerName)
void	resequenceDelegateHandler(java.lang.String aHandlerName, int aNewPositionInHandlerChain)
void	setController(AnalysisEngineController controller)
void	setDelegate(Handler aHandler)
void	setParent(Handler aHandler)
void	validate(java.lang.Object anObjectToHandle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandlerBase

public HandlerBase(java.lang.String aName)

Method Detail

getController

public AnalysisEngineController getController()

setController

public void setController(AnalysisEngineController controller)

populateErrorContext

public static ErrorContext populateErrorContext(MessageContext aMessageCtx)

validate

public void validate(java.lang.Object anObjectToHandle)
              throws AsynchAEException

Throws:

AsynchAEException

isHandlerForMessage

public boolean isHandlerForMessage(MessageContext aMessageContext,
                                   int anExpectedMessageType,
                                   int anExpectedCommand)
                            throws AsynchAEException

Specified by:

isHandlerForMessage in interface Handler

Throws:

AsynchAEException

invokeProcess

public void invokeProcess(org.apache.uima.cas.CAS aCAS,
                          java.lang.String anInputCasReferenceId,
                          java.lang.String aNewCasReferenceId,
                          MessageContext aMessageContext,
                          java.lang.String aNewCasProducedBy)
                   throws AsynchAEException

Specified by:

invokeProcess in interface Handler

Throws:

AsynchAEException

delegate

public void delegate(MessageContext aMessageContext)
              throws AsynchAEException

Specified by:

delegate in interface Handler

Throws:

AsynchAEException

getDelegate

public Handler getDelegate()

Specified by:

getDelegate in interface Handler

setParent

public void setParent(Handler aHandler)

getName

public java.lang.String getName()

Specified by:

getName in interface Handler

setDelegate

public void setDelegate(Handler aHandler)

Specified by:

setDelegate in interface Handler

hasDelegateHandler

public boolean hasDelegateHandler()

Specified by:

hasDelegateHandler in interface Handler

removeDelegate

public void removeDelegate(java.lang.String aHandlerName)

Specified by:

removeDelegate in interface Handler

resequenceDelegateHandler

public void resequenceDelegateHandler(java.lang.String aHandlerName,
                                      int aNewPositionInHandlerChain)

Specified by:

resequenceDelegateHandler in interface Handler

handle

public void handle(java.lang.Object anObjectToHandle)
            throws AsynchAEException

Specified by:

handle in interface Handler

Throws:

AsynchAEException

handle

public void handle(java.lang.Object anObjectToHandle,
                   java.lang.String expectedOutputType)
            throws AsynchAEException

Specified by:

handle in interface Handler

Throws:

AsynchAEException

aggregateDelegateStats

protected void aggregateDelegateStats(MessageContext aMessageContext,
                                      java.lang.String aCasReferenceId)
                               throws AsynchAEException

Throws:

AsynchAEException

computeStats

protected void computeStats(MessageContext aMessageContext,
                            java.lang.String aCasReferenceId)
                     throws AsynchAEException

Throws:

AsynchAEException