Package org.apache.uima.aae.client

Class UimaAsBaseCallbackListener

java.lang.Object
org.apache.uima.aae.client.UimaAsBaseCallbackListener
All Implemented Interfaces:
UimaASStatusCallbackListener
Direct Known Subclasses:
JmsAnalysisEngineServiceStub
public abstract class UimaAsBaseCallbackListener extends Object implements UimaASStatusCallbackListener
This is an abstract listener class that provides empty implementation. The user listener code extends this class to provide concrete implementations for the notification APIs.

  • Constructor Details

    • UimaAsBaseCallbackListener

      public UimaAsBaseCallbackListener()

  • Method Details

    • onBeforeMessageSend

      public void onBeforeMessageSend(UimaASProcessStatus status)
      Called by Uima AS client API just before the CAS is send to the service.
      Parameters:
      status - - status object containing id of the CAS being send.

    • initializationComplete

      public void initializationComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
      The callback used to inform the application that the initialization request has completed. On success aStatus will be null; on failure use the EntityProcessStatus class to get the details.
      Specified by:
      initializationComplete in interface UimaASStatusCallbackListener
      Parameters:
      aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

    • entityProcessComplete

      public void entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus)
      Called when the processing of each entity has completed.
      Specified by:
      entityProcessComplete in interface UimaASStatusCallbackListener
      Parameters:
      aCas - the CAS containing the processed entity and the analysis results
      aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

    • collectionProcessComplete

      public void collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
      The callback used to inform the application that the CPC request has completed. On success aStatus will be null; on failure use the EntityProcessStatus class to get the details.
      Specified by:
      collectionProcessComplete in interface UimaASStatusCallbackListener
      Parameters:
      aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.