org.apache.uima.adapter.vinci
Class VinciAnalysisEngineServiceStub

java.lang.Object
  extended by org.apache.uima.adapter.vinci.VinciAnalysisEngineServiceStub
All Implemented Interfaces:
AnalysisEngineServiceStub, ResourceServiceStub

public class VinciAnalysisEngineServiceStub
extends java.lang.Object
implements AnalysisEngineServiceStub


Constructor Summary
VinciAnalysisEngineServiceStub(java.lang.String endpointURI, java.lang.Integer timeout, Resource owner, Parameter[] parameters)
           
VinciAnalysisEngineServiceStub(java.lang.String endpointURI, Resource owner)
           
 
Method Summary
 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 retreive resource meta data.
 java.util.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(java.lang.String endpointURI,
                                      Resource owner)
                               throws ResourceInitializationException
Throws:
ResourceInitializationException

VinciAnalysisEngineServiceStub

public VinciAnalysisEngineServiceStub(java.lang.String endpointURI,
                                      java.lang.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 retreive resource meta data.

Specified by:
callGetMetaData in interface ResourceServiceStub
Returns:
metadata for the Resource
Throws:
ResourceServiceException
See Also:
org.apache.uima.resource.service.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
See Also:
org.apache.uima.analysis_engine.service.AnalysisEngineServiceStub#callProcess(CAS)

callProcessCas

public void callProcessCas(CAS aCAS)
                    throws ResourceServiceException
Throws:
ResourceServiceException
See Also:
CasObjectProcessorServiceStub#callProcessCas(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:
org.apache.uima.resource.service.impl.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
See Also:
org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callBatchProcessComplete()

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
See Also:
org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callCollectionProcessComplete()

callIsReadOnly

public boolean callIsReadOnly()
                       throws ResourceServiceException
Throws:
ResourceServiceException
See Also:
org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callIsReadOnly()

callIsStateless

public boolean callIsStateless()
                        throws ResourceServiceException
Throws:
ResourceServiceException
See Also:
org.apache.uima.collection.impl.service.CasObjectProcessorServiceStub#callIsStateless()

callGetSupportedXCasVersions

public java.util.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


Copyright © 2013. All Rights Reserved.