Package 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 java.lang.Object
implements AnalysisEngineServiceStub

The Class VinciAnalysisEngineServiceStub.

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	debug	The Constant debug.
private int	mGetMetaDataTimeout	Timeout to use for getMetaData calls.
private Resource	mOwner	The m owner.
private int	mTimeout	Timeout to use for process and collectionProcessComplete calls.
private VinciClient	mVinciClient	The m vinci client.
private static java.util.List	SUPPORT_XCAS_V1	Value to return from callGetSupportedXCasVersions method for older services that don't actually implement this method.

Constructor Summary

Constructors

Constructor	Description
VinciAnalysisEngineServiceStub(java.lang.String endpointURI, java.lang.Integer timeout, Resource owner, Parameter[] parameters)	Instantiates a new vinci analysis engine service stub.
VinciAnalysisEngineServiceStub(java.lang.String endpointURI, Resource owner)	Instantiates a new vinci analysis engine service stub.

Method Summary

Modifier and Type	Method	Description
void	callBatchProcessComplete()	Call batch process complete.
void	callCollectionProcessComplete()	Call collection process complete.
ResourceMetaData	callGetMetaData()	Call get meta data.
java.util.List	callGetSupportedXCasVersions()	Call get supported X cas versions.
boolean	callIsReadOnly()	Call is read only.
boolean	callIsStateless()	Call is stateless.
void	callProcess(CAS aCAS)	Call process.
void	callProcessCas(CAS aCAS)	Call process cas.
void	destroy()	Destroy.
private void	doProcess(CAS aCAS)	The actual process call.
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

Field Detail

mVinciClient

private VinciClient mVinciClient

The m vinci client.

mOwner

private Resource mOwner

The m owner.

mTimeout

private int mTimeout

Timeout to use for process and collectionProcessComplete calls.

mGetMetaDataTimeout

private int mGetMetaDataTimeout

Timeout to use for getMetaData calls.

debug

private static final boolean debug

The Constant debug.

SUPPORT_XCAS_V1

private static final java.util.List SUPPORT_XCAS_V1

Value to return from callGetSupportedXCasVersions method for older services that don't actually implement this method.

Constructor Detail

VinciAnalysisEngineServiceStub

public VinciAnalysisEngineServiceStub(java.lang.String endpointURI,
                                      Resource owner)
                               throws ResourceInitializationException

Instantiates a new vinci analysis engine service stub.

Parameters:

endpointURI - the endpoint URI

owner - the owner

Throws:

ResourceInitializationException - the resource initialization exception

VinciAnalysisEngineServiceStub

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

Instantiates a new vinci analysis engine service stub.

Parameters:

endpointURI - the endpoint URI

timeout - the timeout

owner - the owner

parameters - the parameters

Throws:

ResourceInitializationException - the resource initialization exception

Method Detail

callGetMetaData

public ResourceMetaData callGetMetaData()
                                 throws ResourceServiceException

Call get meta data.

Specified by:

callGetMetaData in interface ResourceServiceStub

Returns:

the resource meta data

Throws:

ResourceServiceException - the resource service exception

See Also:

ResourceServiceStub.callGetMetaData()

callProcess

public void callProcess(CAS aCAS)
                 throws ResourceServiceException

Call process.

Specified by:

callProcess in interface AnalysisEngineServiceStub

Parameters:

aCAS - the a CAS

Throws:

ResourceServiceException - the resource service exception

See Also:

AnalysisEngineServiceStub.callProcess(CAS)

callProcessCas

public void callProcessCas(CAS aCAS)
                    throws ResourceServiceException

Call process cas.

Parameters:

aCAS - the a CAS

Throws:

ResourceServiceException - the resource service exception

See Also:

CasObjectProcessor.processCas(CAS)

doProcess

private void doProcess(CAS aCAS)
                throws ResourceServiceException

The actual process call.

Parameters:

aCAS - the a CAS

Throws:

ResourceServiceException - the resource service exception

destroy

public void destroy()

Destroy.

Specified by:

destroy in interface ResourceServiceStub

See Also:

ResourceServiceStub.destroy()

callBatchProcessComplete

public void callBatchProcessComplete()
                              throws ResourceServiceException

Call batch process complete.

Specified by:

callBatchProcessComplete in interface AnalysisEngineServiceStub

Throws:

ResourceServiceException - the resource service exception

See Also:

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

callCollectionProcessComplete

public void callCollectionProcessComplete()
                                   throws ResourceServiceException

Call collection process complete.

Specified by:

callCollectionProcessComplete in interface AnalysisEngineServiceStub

Throws:

ResourceServiceException - the resource service exception

See Also:

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

callIsReadOnly

public boolean callIsReadOnly()
                       throws ResourceServiceException

Call is read only.

Returns:

true, if successful

Throws:

ResourceServiceException - the resource service exception

See Also:

CasProcessor.isReadOnly()

callIsStateless

public boolean callIsStateless()
                        throws ResourceServiceException

Call is stateless.

Returns:

true, if successful

Throws:

ResourceServiceException - the resource service exception

See Also:

CasProcessor.isStateless()

callGetSupportedXCasVersions

public java.util.List callGetSupportedXCasVersions()
                                            throws ResourceServiceException

Call get supported X cas versions.

Returns:

the list

Throws:

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