org.apache.uima.adapter.vinci

Class VinciAnalysisEngineServiceStub

java.lang.Object

org.apache.uima.adapter.vinci.VinciAnalysisEngineServiceStub

All Implemented Interfaces:

AnalysisEngineServiceStub, ResourceServiceStub

public class VinciAnalysisEngineServiceStub
extends Object
implements AnalysisEngineServiceStub

Constructor Summary

Constructors

Constructor and Description
VinciAnalysisEngineServiceStub(String endpointURI, Integer timeout, Resource owner, Parameter[] parameters)
VinciAnalysisEngineServiceStub(String endpointURI, Resource owner)

Method Summary

Modifier and Type	Method and Description
void	callBatchProcessComplete() Performs service call to inform the AnalysisEngine that the processing of a batch has been completed.
void	callCollectionProcessComplete() Performs service call to inform the AnalysisEngine that the processing of a collection has been completed.
ResourceMetaData	callGetMetaData() Performs service call to retrieve resource meta data.
List	callGetSupportedXCasVersions()
boolean	callIsReadOnly()
boolean	callIsStateless()
void	callProcess(CAS aCAS) Performs service call to process an entity.
void	callProcessCas(CAS aCAS)
void	destroy() Called when this stub is no longer needed, so any open connections can be closed.
protected boolean	isSocketKeepAliveEnabled() Gets whether socket keepAlive is enabled, by consulting the PerformanceTuningSettings.

Methods inherited from class java.lang.Object

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

Constructor Detail

VinciAnalysisEngineServiceStub

public VinciAnalysisEngineServiceStub(String endpointURI,
                                      Resource owner)
                               throws ResourceInitializationException

Throws:

ResourceInitializationException

VinciAnalysisEngineServiceStub

public VinciAnalysisEngineServiceStub(String endpointURI,
                                      Integer timeout,
                                      Resource owner,
                                      Parameter[] parameters)
                               throws ResourceInitializationException

Throws:

ResourceInitializationException

Method Detail

callGetMetaData

public ResourceMetaData callGetMetaData()
                                 throws ResourceServiceException

Description copied from interface: ResourceServiceStub

Performs service call to retrieve resource meta data.

Specified by:

callGetMetaData in interface ResourceServiceStub

Returns:

metadata for the Resource

Throws:

ResourceServiceException - passthru

See Also:

ResourceServiceStub.callGetMetaData()

callProcess

public void callProcess(CAS aCAS)
                 throws ResourceServiceException

Description copied from interface: AnalysisEngineServiceStub

Performs service call to process an entity.

Specified by:

callProcess in interface AnalysisEngineServiceStub

Parameters:

aCAS - the CAS to process

Throws:

ResourceServiceException - tbd

See Also:

AnalysisEngineServiceStub.callProcess(CAS)

callProcessCas

public void callProcessCas(CAS aCAS)
                    throws ResourceServiceException

Throws:

ResourceServiceException

See Also:

CasObjectProcessor.processCas(CAS)

destroy

public void destroy()

Description copied from interface: ResourceServiceStub

Called when this stub is no longer needed, so any open connections can be closed.

Specified by:

destroy in interface ResourceServiceStub

See Also:

ResourceServiceStub.destroy()

callBatchProcessComplete

public void callBatchProcessComplete()
                              throws ResourceServiceException

Description copied from interface: AnalysisEngineServiceStub

Performs service call to inform the AnalysisEngine that the processing of a batch has been completed.

Specified by:

callBatchProcessComplete in interface AnalysisEngineServiceStub

Throws:

ResourceServiceException - tbd

See Also:

CasProcessor.batchProcessComplete(org.apache.uima.util.ProcessTrace)

callCollectionProcessComplete

public void callCollectionProcessComplete()
                                   throws ResourceServiceException

Description copied from interface: AnalysisEngineServiceStub

Performs service call to inform the AnalysisEngine that the processing of a collection has been completed.

Specified by:

callCollectionProcessComplete in interface AnalysisEngineServiceStub

Throws:

ResourceServiceException - tbd

See Also:

CasProcessor.collectionProcessComplete(org.apache.uima.util.ProcessTrace)

callIsReadOnly

public boolean callIsReadOnly()
                       throws ResourceServiceException

Throws:

ResourceServiceException

See Also:

CasProcessor.isReadOnly()

callIsStateless

public boolean callIsStateless()
                        throws ResourceServiceException

Throws:

ResourceServiceException

See Also:

CasProcessor.isStateless()

callGetSupportedXCasVersions

public List callGetSupportedXCasVersions()
                                  throws ResourceServiceException

Throws:

ResourceServiceException

isSocketKeepAliveEnabled

protected boolean isSocketKeepAliveEnabled()

Gets whether socket keepAlive is enabled, by consulting the PerformanceTuningSettings. (If no setting specified, defaults to true.)

Returns:

if socketKeepAlive is enabled