org.apache.uima.adapter.soap
Class AxisAnalysisEngineServiceStub

java.lang.Object
  org.apache.uima.adapter.soap.AxisResourceServiceStub
      org.apache.uima.adapter.soap.AxisAnalysisEngineServiceStub

All Implemented Interfaces:

AnalysisEngineServiceStub, ResourceServiceStub

public class AxisAnalysisEngineServiceStub
extends AxisResourceServiceStub
implements AnalysisEngineServiceStub

Proxy to an AnalysisEngineService that makes use of Axis SOAP to communicate with the service.

Constructor Summary

AxisAnalysisEngineServiceStub(java.lang.String aEndpoint, java.lang.Integer aTimeout)
Sets the endpoint of the service with which this proxy communicates.

AxisAnalysisEngineServiceStub(java.lang.String aEndpoint, java.lang.Integer aTimeout, boolean aUseAttachments)
Sets the endpoint of the service with which this proxy communicates.

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.
void	callProcess(CAS aCAS) Performs service call to process an entity.
void	destroy() Called when this stub is no longer needed, so any open connections can be closed.

Methods inherited from class org.apache.uima.adapter.soap.AxisResourceServiceStub

callGetMetaData, getServiceEndpoint, getTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.ResourceServiceStub

callGetMetaData

Constructor Detail

AxisAnalysisEngineServiceStub

public AxisAnalysisEngineServiceStub(java.lang.String aEndpoint,
                                     java.lang.Integer aTimeout)
                              throws java.net.MalformedURLException

Sets the endpoint of the service with which this proxy communicates.

Parameters:

aEndpoint - the service endpoint URI

aTimeout - the timeout period in millseconds, or null to use Axis's default value

Throws:

java.net.MalformedURLException - if aEndpoint is not a valid URL

AxisAnalysisEngineServiceStub

public AxisAnalysisEngineServiceStub(java.lang.String aEndpoint,
                                     java.lang.Integer aTimeout,
                                     boolean aUseAttachments)
                              throws java.net.MalformedURLException

Sets the endpoint of the service with which this proxy communicates.

Parameters:

aEndpoint - the service endpoint URI

aTimeout - the timeout period in millseconds, or null to use Axis's default value

aUseAttachments - whether attachments should be used to send binary-serialized data

Throws:

java.net.MalformedURLException - if aEndpoint is not a valid URL

Method Detail

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.reference_impl.analysis_engine.service.AnalysisEngineServiceStub#callProcess(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.reference_impl.resource.service.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

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