org.apache.uima.adapter.vinci

Class VinciAnalysisEngineServiceStub

java.lang.Object

org.apache.uima.adapter.vinci.VinciAnalysisEngineServiceStub

All Implemented Interfaces:

org.apache.uima.analysis_engine.AnalysisEngineServiceStub, org.apache.uima.resource.ResourceServiceStub

public class VinciAnalysisEngineServiceStub
extends Object
implements org.apache.uima.analysis_engine.AnalysisEngineServiceStub

The Class VinciAnalysisEngineServiceStub.

Constructor Summary

Constructors

Constructor and Description
VinciAnalysisEngineServiceStub(String endpointURI, Integer timeout, org.apache.uima.resource.Resource owner, org.apache.uima.resource.Parameter[] parameters) Instantiates a new vinci analysis engine service stub.
VinciAnalysisEngineServiceStub(String endpointURI, org.apache.uima.resource.Resource owner) Instantiates a new vinci analysis engine service stub.

Method Summary

Modifier and Type	Method and Description
void	callBatchProcessComplete() Call batch process complete.
void	callCollectionProcessComplete() Call collection process complete.
org.apache.uima.resource.metadata.ResourceMetaData	callGetMetaData() Call get meta data.
List	callGetSupportedXCasVersions() Call get supported X cas versions.
boolean	callIsReadOnly() Call is read only.
boolean	callIsStateless() Call is stateless.
void	callProcess(org.apache.uima.cas.CAS aCAS) Call process.
void	callProcessCas(org.apache.uima.cas.CAS aCAS) Call process cas.
void	destroy() Destroy.
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,
                                      org.apache.uima.resource.Resource owner)
                               throws org.apache.uima.resource.ResourceInitializationException

Instantiates a new vinci analysis engine service stub.

Parameters:

endpointURI - the endpoint URI

owner - the owner

Throws:

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception

VinciAnalysisEngineServiceStub

public VinciAnalysisEngineServiceStub(String endpointURI,
                                      Integer timeout,
                                      org.apache.uima.resource.Resource owner,
                                      org.apache.uima.resource.Parameter[] parameters)
                               throws org.apache.uima.resource.ResourceInitializationException

Instantiates a new vinci analysis engine service stub.

Parameters:

endpointURI - the endpoint URI

timeout - the timeout

owner - the owner

parameters - the parameters

Throws:

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception

Method Detail

callGetMetaData

public org.apache.uima.resource.metadata.ResourceMetaData callGetMetaData()
                                                                   throws org.apache.uima.resource.ResourceServiceException

Call get meta data.

Specified by:

callGetMetaData in interface org.apache.uima.resource.ResourceServiceStub

Returns:

the resource meta data

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

ResourceServiceStub.callGetMetaData()

callProcess

public void callProcess(org.apache.uima.cas.CAS aCAS)
                 throws org.apache.uima.resource.ResourceServiceException

Call process.

Specified by:

callProcess in interface org.apache.uima.analysis_engine.AnalysisEngineServiceStub

Parameters:

aCAS - the a CAS

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

AnalysisEngineServiceStub.callProcess(CAS)

callProcessCas

public void callProcessCas(org.apache.uima.cas.CAS aCAS)
                    throws org.apache.uima.resource.ResourceServiceException

Call process cas.

Parameters:

aCAS - the a CAS

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

CasObjectProcessor.processCas(CAS)

destroy

public void destroy()

Destroy.

Specified by:

destroy in interface org.apache.uima.resource.ResourceServiceStub

See Also:

ResourceServiceStub.destroy()

callBatchProcessComplete

public void callBatchProcessComplete()
                              throws org.apache.uima.resource.ResourceServiceException

Call batch process complete.

Specified by:

callBatchProcessComplete in interface org.apache.uima.analysis_engine.AnalysisEngineServiceStub

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

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

callCollectionProcessComplete

public void callCollectionProcessComplete()
                                   throws org.apache.uima.resource.ResourceServiceException

Call collection process complete.

Specified by:

callCollectionProcessComplete in interface org.apache.uima.analysis_engine.AnalysisEngineServiceStub

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

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

callIsReadOnly

public boolean callIsReadOnly()
                       throws org.apache.uima.resource.ResourceServiceException

Call is read only.

Returns:

true, if successful

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

CasProcessor.isReadOnly()

callIsStateless

public boolean callIsStateless()
                        throws org.apache.uima.resource.ResourceServiceException

Call is stateless.

Returns:

true, if successful

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

See Also:

CasProcessor.isStateless()

callGetSupportedXCasVersions

public List callGetSupportedXCasVersions()
                                  throws org.apache.uima.resource.ResourceServiceException

Call get supported X cas versions.

Returns:

the list

Throws:

org.apache.uima.resource.ResourceServiceException - the resource service exception

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