gov.va.vinci.leo

Class Client

java.lang.Object

gov.va.vinci.leo.tools.LeoProperties

gov.va.vinci.leo.Client

public class Client
extends LeoProperties

Initialize and execute a pipeline via the client API for UIMA AS which has been created via the Service object. Utilizes the same Engine created and provided by the Service.

Author:

thomasginter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.LeoEngine Extends the Base engine in order to expose the listeners in a getter.

Field Summary

Fields

Modifier and Type	Field and Description
protected LeoCollectionReaderInterface	collectionReader Collection reader used for reading documents in and sending them to the service.
protected boolean	isUAListenerAdded Flag to let us know if a UAB Listener has been added.
protected static org.apache.log4j.Logger	LOG Logger object.
protected Map<String,Object>	mAppCtx Application execution map used primarily by the client.
protected Client.LeoEngine	mUAEngine UIMA Asynchronous Engine object used to deploy the server and later to init and run the client side of the service also.
protected String	performanceReport Holds performance report data from the engine after processing is complete.

Fields inherited from class gov.va.vinci.leo.tools.LeoProperties

BROKERURL_DEFAULT, ENDPOINT_DEFAULT, mAggregateDescriptorFile, mBrokerURL, mCasPoolSize, mCCTimeout, mDeleteOnExit, mDeploymentDescriptorFile, mDescriptorDirectory, mEndpoint, mFSHeapSize, mInitTimeout, mJamJmxPort, mJamQueryIntervalInSeconds, mJamResetStatisticsAfterQuery, mJamServerBaseUrl, mPropertiesFile, mServiceName, mTimeout, PROPERTIES_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Client(String propertiesFile, LeoCollectionReaderInterface collectionReader, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners) Constructor with properties file input for client execution context, a collection reader for input, and option listeners.
Client(String propertiesFile, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners) Constructor with properties file input for client execution context.
Client(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners) Default Constructor, will try to load properties from file located at conf/leo.properties.

Method Summary

Modifier and Type	Method and Description
void	addUABListener(org.apache.uima.aae.client.UimaAsBaseCallbackListener uaListener) Set a reference to the UABCallbackListener object for handling service events.
protected void	finalize()
LeoCollectionReaderInterface	getLeoCollectionReader() Get the collection reader for this client.
List	getListeners() Get the list of listeners that have been registered with the client.
String	getPerformanceReport() Get the performance report stored after the last "run" invocation in this client object.
org.apache.uima.resource.metadata.TypeSystemDescription	getServiceTypeSystemDescription() Calls the service to determine the TypeSystemDescription it is using, and returns it.
static org.apache.uima.resource.metadata.TypeSystemDescription	getServiceTypeSystemDescription(String brokerURL, String inputQueueName) Calls the service to determine the TypeSystemDescription it is using, and returns it.
String	getServiceTypeSystemDescriptionXml() Returns the remote service TypeSystemDescription in xml.
static String	getServiceTypeSystemDescriptionXml(String brokerURL, String inputQueueName) Returns the remote service TypeSystemDescription in xml.
protected void	init(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Initialize the client engine and application context.
void	run(org.apache.uima.cas.CAS cas, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Run the pipeline on a single CAS object.
void	run(InputStream stream, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Run the pipeline on one document at a time using the document text provided.
void	run(LeoCollectionReaderInterface collectionReader, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Execute the AS pipeline using the LeoCollectionReaderInterface object.
void	run(String documentText, org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Run the pipeline on one document at a time using the document text provided.
void	run(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs) Run with the collection reader that is already set in the client.
void	setLeoCollectionReader(LeoCollectionReaderInterface reader) Set the collection reader for this client.
void	validateData() Validate the required data for client execution.

Methods inherited from class gov.va.vinci.leo.tools.LeoProperties

getAggregateDescriptorFile, getBrokerURL, getCasPoolSize, getCCTimeout, getDeploymentDescriptorFile, getDescriptorDirectory, getEndpoint, getFSHeapSize, getInitTimeout, getInputQueueName, getJamJmxPort, getJamQueryIntervalInSeconds, getJamServerBaseUrl, getServiceName, getTimeout, isDeleteOnExit, isJamResetStatisticsAfterQuery, loadDefaults, loadProperties, loadprops, loadprops, setAggregateDescriptorFile, setBrokerURL, setCasPoolSize, setCCTimeout, setDeleteOnExit, setDeploymentDescriptorFile, setDescriptorDirectory, setEndpoint, setFSHeapSize, setInitTimeout, setInputQueueName, setJamJmxPort, setJamQueryIntervalInSeconds, setJamResetStatisticsAfterQuery, setJamServerBaseUrl, setServiceName, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

mUAEngine

protected Client.LeoEngine mUAEngine

UIMA Asynchronous Engine object used to deploy the server and later to init and run the client side of the service also.

mAppCtx

protected Map<String,Object> mAppCtx

Application execution map used primarily by the client.

performanceReport

protected String performanceReport

Holds performance report data from the engine after processing is complete.

isUAListenerAdded

protected boolean isUAListenerAdded

Flag to let us know if a UAB Listener has been added.

LOG

protected static final org.apache.log4j.Logger LOG

Logger object.

collectionReader

protected LeoCollectionReaderInterface collectionReader

Collection reader used for reading documents in and sending them to the service.

Constructor Detail

Client

public Client(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners)

Default Constructor, will try to load properties from file located at conf/leo.properties.

Parameters:

uaListeners - Listeners that will catch Service callback events

Client

public Client(String propertiesFile,
              org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners)
       throws Exception

Constructor with properties file input for client execution context.

Parameters:

propertiesFile - the full path to the properties file for client properties.

uaListeners - Listeners that will catch Service callback events

Throws:

Exception - if there is an error loading properties.

Client

public Client(String propertiesFile,
              LeoCollectionReaderInterface collectionReader,
              org.apache.uima.aae.client.UimaAsBaseCallbackListener... uaListeners)
       throws Exception

Constructor with properties file input for client execution context, a collection reader for input, and option listeners.

Parameters:

propertiesFile - the full path to the properties file for client properties.

collectionReader - the input collection reader for this client.

uaListeners - Listeners that will catch Service callback events

Throws:

Exception - if there is an error loading properties.

Method Detail

setLeoCollectionReader

public void setLeoCollectionReader(LeoCollectionReaderInterface reader)

Set the collection reader for this client.

Parameters:

reader - the collection reader for this client.

getLeoCollectionReader

public LeoCollectionReaderInterface getLeoCollectionReader()

Get the collection reader for this client.

Returns:

the collection reader for this client.

addUABListener

public void addUABListener(org.apache.uima.aae.client.UimaAsBaseCallbackListener uaListener)

Set a reference to the UABCallbackListener object for handling service events.

Parameters:

uaListener - adds a callback gov.va.vinci.leo.listener for this client.

validateData

public void validateData()
                  throws Exception

Validate the required data for client execution.

Throws:

Exception - if any data required for the client is missing.

init

protected void init(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
             throws Exception

Initialize the client engine and application context.

Parameters:

uabs - Listeners that will catch Service callback events

Throws:

Exception - if any data required for the client is missing.

run

public void run(org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
         throws Exception

Run with the collection reader that is already set in the client.

Parameters:

uabs - List of Listeners that will catch callback events from the service

Throws:

Exception - if any error occurs during processing

run

public void run(LeoCollectionReaderInterface collectionReader,
                org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
         throws Exception

Execute the AS pipeline using the LeoCollectionReaderInterface object.

Parameters:

collectionReader - LeoCollectionReaderInterface that will produce CASes for the pipeline

uabs - List of Listeners that will catch callback events from the service

Throws:

Exception - if any error occurs during processing

run

public void run(InputStream stream,
                org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
         throws Exception

Run the pipeline on one document at a time using the document text provided.

Parameters:

stream - the input stream to read the document from.

uabs - List of Listeners that will catch callback events from the service

Throws:

Exception - if any error occurs during processing

run

public void run(String documentText,
                org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
         throws Exception

Run the pipeline on one document at a time using the document text provided.

Parameters:

documentText - the document text to process.

uabs - List of Listeners that will catch callback events from the service

Throws:

Exception - if any error occurs during processing

run

public void run(org.apache.uima.cas.CAS cas,
                org.apache.uima.aae.client.UimaAsBaseCallbackListener... uabs)
         throws Exception

Run the pipeline on a single CAS object.

Parameters:

cas - an individual cass to process through the client.

uabs - List of Listeners that will catch callback events from the service

Throws:

Exception - if any error occurs during processing

getListeners

public List getListeners()

Get the list of listeners that have been registered with the client. If no listeners have been registered or the engine has not been initialized, then an empty list will be returned.

Returns:

List of registered listeners

getPerformanceReport

public String getPerformanceReport()

Get the performance report stored after the last "run" invocation in this client object.

Returns:

UAEngine performance report as a String object

getServiceTypeSystemDescription

public static org.apache.uima.resource.metadata.TypeSystemDescription getServiceTypeSystemDescription(String brokerURL,
                                                                                                      String inputQueueName)
                                                                                               throws Exception

Calls the service to determine the TypeSystemDescription it is using, and returns it.

Parameters:

brokerURL - URL of the broker where the service resides.

inputQueueName - Name of the endpoint, or input queue for the service to query.

Returns:

the TypeSystemDescription for the remote service.

Throws:

Exception - if there is an exception getting the type system from the engine.

getServiceTypeSystemDescription

public org.apache.uima.resource.metadata.TypeSystemDescription getServiceTypeSystemDescription()
                                                                                        throws Exception

Calls the service to determine the TypeSystemDescription it is using, and returns it.

Returns:

the TypeSystemDescription for the remote service.

Throws:

Exception - if there is an exception getting the type system from the engine.

getServiceTypeSystemDescriptionXml

public static String getServiceTypeSystemDescriptionXml(String brokerURL,
                                                        String inputQueueName)
                                                 throws Exception

Returns the remote service TypeSystemDescription in xml. Typically for being written out to a file for other tools such as the UIMA annotation viewer to use.

Parameters:

brokerURL - URL of the broker where the service resides.

inputQueueName - Name of the endpoint, or input queue for the service to query.

Returns:

the type system description in xml format.

Throws:

Exception - if there is an exception getting the type system from the engine.

getServiceTypeSystemDescriptionXml

public String getServiceTypeSystemDescriptionXml()
                                          throws Exception

Returns the remote service TypeSystemDescription in xml. Typically for being written out to a file for other tools such as the UIMA annotation viewer to use.

Returns:

the type system description in xml format.

Throws:

Exception - if there is an exception getting the type system from the engine.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable - if any exception is thrown by the engine during the stop() call.

See Also:

Object.finalize()