Package org.apache.uima.adapter.vinci
Class VinciBinaryAnalysisEngineService_impl
java.lang.Object
org.apache.vinci.transport.VinciServableAdapter
org.apache.uima.adapter.vinci.VinciBinaryAnalysisEngineService_impl
- All Implemented Interfaces:
TransportableFactory
,VinciServable
Main class for a Vinci Analysis Engine service that uses the binary CAS serialization, rather
than XCAS. This class can also be used to deploy CAS Consumers as Vinci Services.
The main method takes one argument - the path to the service deployment descriptor.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Class that handles service shutdowns (including Ctrl-C). -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate VinciServer
The server.private boolean
The debug.private Descriptor
The descriptor.private AnalysisEngine
The m AE.private CasPool
The m cas pool.private int
The service instance id. -
Constructor Summary
ConstructorsConstructorDescriptionVinciBinaryAnalysisEngineService_impl
(String serviceConfigPath) Instantiate Analysis Engine from a given descriptor.VinciBinaryAnalysisEngineService_impl
(String serviceConfigPath, boolean debug) Instantiate Analysis Engine from a given descriptor - possibly in debug mode.VinciBinaryAnalysisEngineService_impl
(String serviceConfigPath, boolean debug, String instanceId) Instantiate Analysis Engine from a given descriptor - possibly in debug mode. -
Method Summary
Modifier and TypeMethodDescriptionprivate Transportable
Analyzes a given document by a CasObjectProcessor.eval
(Transportable doc) Main method called by the Vinci Service Layer.Gets the descriptor.private Frame
Extracts AE metadata.static void
The main method.Make transportable.private static void
Redirects all logger output for this JVM to the given output stream.protected void
start()
Starts this service and associates a ShutdownHook to handle gracefull shutdown.void
stop()
Terminate this service.Methods inherited from class org.apache.vinci.transport.VinciServableAdapter
cleanExit
-
Field Details
-
_server
The server. -
mAE
The m AE. -
mCasPool
The m cas pool. -
descriptor
The descriptor. -
debug
private boolean debugThe debug. -
serviceInstanceId
private int serviceInstanceIdThe service instance id.
-
-
Constructor Details
-
VinciBinaryAnalysisEngineService_impl
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug, String instanceId) throws Exception Instantiate Analysis Engine from a given descriptor - possibly in debug mode.- Parameters:
serviceConfigPath
- descriptor locationdebug
- the debuginstanceId
- the instance id- Throws:
Exception
- the exception
-
VinciBinaryAnalysisEngineService_impl
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug) throws Exception Instantiate Analysis Engine from a given descriptor - possibly in debug mode.- Parameters:
serviceConfigPath
- descriptor locationdebug
- the debug- Throws:
Exception
- the exception
-
VinciBinaryAnalysisEngineService_impl
Instantiate Analysis Engine from a given descriptor.- Parameters:
serviceConfigPath
- descriptor location- Throws:
Exception
- the exception
-
-
Method Details
-
getMetaData
Extracts AE metadata.- Returns:
- Frame containing extracted meta data
- Throws:
Exception
- the exception
-
getDescriptor
Gets the descriptor.- Returns:
- the descriptor
-
analyze
Analyzes a given document by a CasObjectProcessor. When completed this method returns a VinciFrame containing XCAS translated into a set of Vinci subFrames. Each subframe containing one annotation with all its attributes.- Parameters:
aRequestFrame
- request frame- Returns:
- VinciFrame containing XCAS translated into a set of Vinci subframes.
- Throws:
ServiceException
- the service exception
-
eval
Main method called by the Vinci Service Layer. All requests coming in from clients go through this method. Each request comes in as a VinciFrame and is expected to contain a valid VINCI:COMMAND. Currently, two such operations are supported: 1) Annotate - triggers document analysis 2) GetData - triggers return of the AE meta data ( descriptor)- Specified by:
eval
in interfaceVinciServable
- Specified by:
eval
in classVinciServableAdapter
- Parameters:
doc
-Transportable
- a VinciFrame containing client request- Returns:
Transportable
- a VinciFrame containg result of performing the service- Throws:
ServiceException
- the service exception
-
start
protected void start()Starts this service and associates a ShutdownHook to handle gracefull shutdown. -
stop
public void stop()Terminate this service. -
main
The main method.- Parameters:
args
- the arguments
-
redirectLoggerOutput
Redirects all logger output for this JVM to the given output stream.- Parameters:
out
- the out
-
makeTransportable
Make transportable.- Specified by:
makeTransportable
in interfaceTransportableFactory
- Overrides:
makeTransportable
in classVinciServableAdapter
- Returns:
- the transportable
- See Also:
-