Package org.apache.vinci.transport

Class VinciServableAdapter

java.lang.Object

org.apache.vinci.transport.VinciServableAdapter

All Implemented Interfaces:

TransportableFactory, VinciServable

Direct Known Subclasses:

LocalVNS, VinciAnalysisEngineService_impl, VinciBinaryAnalysisEngineService_impl, VNS

public abstract class VinciServableAdapter
extends Object
implements VinciServable

Adapter class for VinciServable, which provides a do-nothing cleanExit() method and a TransportableFactory that returns a VinciFrame.

Constructor Summary

Constructors

Constructor	Description
VinciServableAdapter()

Method Summary

Modifier and Type	Method	Description
void	cleanExit()	Called when the service is being shutdown by the server/service container.
abstract Transportable	eval(Transportable in)	The eval method accepts an input document and returns an output document that is the result of performing the service.
Transportable	makeTransportable()	Creates a new (empty) document of the desired type.

Methods inherited from class java.lang.Object

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

Constructor Details

VinciServableAdapter

public VinciServableAdapter()

Method Details

eval

public abstract Transportable eval(Transportable in)
                            throws ServiceException

Description copied from interface: VinciServable

The eval method accepts an input document and returns an output document that is the result of performing the service.

Specified by:

eval in interface VinciServable

Parameters:

in - The input document

Returns:

The output document

Throws:

ServiceException - thrown when there is an application level error that should result in the client receiving the same ServiceException on the other end.

cleanExit

public void cleanExit()

Description copied from interface: VinciServable

Called when the service is being shutdown by the server/service container.

Specified by:

cleanExit in interface VinciServable

makeTransportable

public Transportable makeTransportable()

Description copied from interface: TransportableFactory

Creates a new (empty) document of the desired type.

Specified by:

makeTransportable in interface TransportableFactory

Returns:

The new document.