/* | |
* Licensed to the Apache Software Foundation (ASF) under one | |
* or more contributor license agreements. See the NOTICE file | |
* distributed with this work for additional information | |
* regarding copyright ownership. The ASF licenses this file | |
* to you under the Apache License, Version 2.0 (the | |
* "License"); you may not use this file except in compliance | |
* with the License. You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, | |
* software distributed under the License is distributed on an | |
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
* KIND, either express or implied. See the License for the | |
* specific language governing permissions and limitations | |
* under the License. | |
*/ | |
package org.apache.uima.aae.client; | |
import org.apache.uima.aae.UimaASApplicationEvent.EventTrigger; | |
import org.apache.uima.cas.CAS; | |
import org.apache.uima.collection.EntityProcessStatus; | |
/** | |
* 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. | |
* | |
*/ | |
public abstract class UimaAsBaseCallbackListener implements UimaASStatusCallbackListener { | |
/** | |
* Called by Uima AS client API just before the CAS is send to the service. | |
* | |
* @param status | |
* - status object containing id of the CAS being send. | |
*/ | |
public void onBeforeMessageSend(UimaASProcessStatus status) { | |
// to be overridden | |
} | |
/** | |
* Called by Uima AS client API before CAS processing begins at the remote | |
* UIMA AS service | |
* | |
* @param status | |
* @param nodeIP | |
* @param pid | |
*/ | |
public void onBeforeProcessCAS(UimaASProcessStatus status, String nodeIP, String pid) { | |
// to be overridden | |
} | |
/** | |
* Called by Uima AS client API before GetMeta processing begins at the remote | |
* UIMA AS service | |
* | |
* @param nodeIP - Node IP where GetMeta request is handled | |
* @param pid - Remote Service PID where GetMeta request is handled. The | |
* has the following syntax: <PID:THREADID> | |
*/ | |
public void onBeforeProcessMeta(String nodeIP, String pid) { | |
// to be overridden | |
} | |
public void onUimaAsServiceExit(EventTrigger cause) { | |
} | |
/** | |
* 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. | |
* | |
* @param aStatus | |
* the status of the processing. This object contains a record of any Exception that | |
* occurred, as well as timing information. | |
*/ | |
public void initializationComplete(EntityProcessStatus aStatus) { | |
} | |
/** | |
* Called when the processing of each entity has completed. | |
* | |
* @param aCas | |
* the CAS containing the processed entity and the analysis results | |
* @param aStatus | |
* the status of the processing. This object contains a record of any Exception that | |
* occurred, as well as timing information. | |
*/ | |
public void entityProcessComplete(CAS aCas, 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. | |
* | |
* @param aStatus | |
* the status of the processing. This object contains a record of any Exception that | |
* occurred, as well as timing information. | |
*/ | |
public void collectionProcessComplete(EntityProcessStatus aStatus) { | |
} | |
} |