gov.va.vinci.leo.descriptors

Class LeoRemoteAEDescriptor

java.lang.Object

gov.va.vinci.leo.descriptors.LeoRemoteAEDescriptor

All Implemented Interfaces:

LeoDelegate

public class LeoRemoteAEDescriptor
extends Object
implements LeoDelegate

Create and modify remote service analysis engine descriptors in order to include remote services in an aggregate. User: Thomas Ginter Date: 10/30/13 Time: 2:51 PM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeoRemoteAEDescriptor.Param Default params for remote service descriptors.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deleteOnExit If TRUE then delete the generated descriptor file once the program exits, defaults to TRUE.
protected URI	mDescriptorLocator Location of the XML representation of this descriptor.
protected org.apache.uima.resource.CustomResourceSpecifier	mRemoteDescriptor Resource specifier reference object.
protected org.apache.uima.resource.Parameter	name Parameter object where the name is stored.

Constructor Summary

Constructors

Constructor and Description
LeoRemoteAEDescriptor() Default constructor creates a blank remote service descriptor.
LeoRemoteAEDescriptor(org.apache.uima.resource.CustomResourceSpecifier crs) Initialize with the CustomResourceSpecifier that represents a remote service.
LeoRemoteAEDescriptor(String descriptor, boolean byName, NameValue... paramValues) Import an XML descriptor and use it as the model.
LeoRemoteAEDescriptor(String brokerURL, String endPoint) Create a remote descriptor with the BrokerURL and Endpoint parameters completed.

Method Summary

Modifier and Type	Method and Description
LeoRemoteAEDescriptor	addParameterSetting(String name, String value) Add a new parameter to the descriptor.
LeoRemoteAEDescriptor	analysisEngineSection(TransformerHandler thd, boolean isTopDescriptor) Produce the Analysis Engine section for the Deployment Descriptor XML.
String	getDescriptorLocator()
String	getName() Get the name of this delegate or null if no name has been set.
protected org.apache.uima.resource.Parameter	getParameterSetting(String name) Get the Parameter object from the descriptor with the name provided or null if the parameter is not found in the descriptor.
protected String	getParameterValue(String name) Get the value of a parameter in the descriptor, returns null if the name is not found in the parameter list.
org.apache.uima.resource.CustomResourceSpecifier	getRemoteDescriptor()
org.apache.uima.resource.ResourceSpecifier	getResourceSpecifier() Return a reference to the internal ResourceSpecifier that is the backend model for the delegate.
boolean	isDeleteOnExit() Returns TRUE if the generated descriptors will be deleted when the program exits.
LeoRemoteAEDescriptor	setDescriptorLocator(URI descriptorLocator) Set the location where the descriptor should be generated.
LeoRemoteAEDescriptor	setIsDeleteOnExit(boolean deleteOnExit) Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them.
LeoRemoteAEDescriptor	setName(String name) Set the name of this remote service, return a reference to the delegate type object in each implementation.
LeoRemoteAEDescriptor	setParameterSetting(NameValue nameValue) Set the remote service parameter from the NameValue pair information provided.
LeoRemoteAEDescriptor	setParameterSetting(org.apache.uima.resource.Parameter p) Set the remote service parameter from the Parameter name and value information.
LeoRemoteAEDescriptor	setParameterSetting(String name, String value) Set the remote parameter setting.
void	toXML() Write the descriptor file out based on the locator information in the object.
void	toXML(String filename) Write the descriptor out to a temp XML file with the name provided as the base filename.

Methods inherited from class java.lang.Object

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

Field Detail

mDescriptorLocator

protected URI mDescriptorLocator

Location of the XML representation of this descriptor.

mRemoteDescriptor

protected org.apache.uima.resource.CustomResourceSpecifier mRemoteDescriptor

Resource specifier reference object.

name

protected org.apache.uima.resource.Parameter name

Parameter object where the name is stored.

deleteOnExit

protected boolean deleteOnExit

If TRUE then delete the generated descriptor file once the program exits, defaults to TRUE.

Constructor Detail

LeoRemoteAEDescriptor

public LeoRemoteAEDescriptor()

Default constructor creates a blank remote service descriptor.

Throws:

Exception

LeoRemoteAEDescriptor

public LeoRemoteAEDescriptor(org.apache.uima.resource.CustomResourceSpecifier crs)

Initialize with the CustomResourceSpecifier that represents a remote service.

Parameters:

crs - CustomResourceSpecifier object representing the remote service.

LeoRemoteAEDescriptor

public LeoRemoteAEDescriptor(String descriptor,
                             boolean byName,
                             NameValue... paramValues)
                      throws IOException,
                             org.apache.uima.util.InvalidXMLException

Import an XML descriptor and use it as the model.

Parameters:

descriptor - String path to the XML descriptor file

byName - if true then import the descriptor by name rather than a literal path

paramValues - Optional parameter values to set after initializing

Throws:

IOException - if there is an error reading the file at the descriptor path

org.apache.uima.util.InvalidXMLException - if there is an error parsing the xml of the descriptor

LeoRemoteAEDescriptor

public LeoRemoteAEDescriptor(String brokerURL,
                             String endPoint)

Create a remote descriptor with the BrokerURL and Endpoint parameters completed.

Parameters:

brokerURL - broker URL to connect.

endPoint - name of the input queue.

Method Detail

getRemoteDescriptor

public org.apache.uima.resource.CustomResourceSpecifier getRemoteDescriptor()

Returns:

reference to the CustomResourceSpecifier object representing this remote service

getResourceSpecifier

public org.apache.uima.resource.ResourceSpecifier getResourceSpecifier()

Return a reference to the internal ResourceSpecifier that is the backend model for the delegate. AnalysisEngines will have a ResourceSpecifier that is an instance of AnalysisEngineDescription whereas remote delegates have a ResourceSpecifier that is a CustomResourceSpecifier.

Specified by:

getResourceSpecifier in interface LeoDelegate

Returns:

ResourceSpecifier object for this delegate

setDescriptorLocator

public LeoRemoteAEDescriptor setDescriptorLocator(URI descriptorLocator)

Set the location where the descriptor should be generated. If a file name is specified it will be ignored and the parent directory path will be used instead.

Specified by:

setDescriptorLocator in interface LeoDelegate

Parameters:

descriptorLocator - URI path where the descriptors should be located

Returns:

reference to this LeoRemoteAEDescriptor instance

getDescriptorLocator

public String getDescriptorLocator()

Specified by:

getDescriptorLocator in interface LeoDelegate

Returns:

Descriptor locator for the AnalysisEngineDescriptor xml file represented by this LeoAEDescriptor object or null if the locator is not set.

getName

public String getName()

Get the name of this delegate or null if no name has been set.

Specified by:

getName in interface LeoDelegate

Returns:

String representing the name of this delegate

setName

public LeoRemoteAEDescriptor setName(String name)

Set the name of this remote service, return a reference to the delegate type object in each implementation.

Specified by:

setName in interface LeoDelegate

Parameters:

name - String name of the remote service

Returns:

reference to the delegate type whose name is set

isDeleteOnExit

public boolean isDeleteOnExit()

Returns TRUE if the generated descriptors will be deleted when the program exits. Default is TRUE.

Specified by:

isDeleteOnExit in interface LeoDelegate

Returns:

TRUE if descriptors will be deleted

setIsDeleteOnExit

public LeoRemoteAEDescriptor setIsDeleteOnExit(boolean deleteOnExit)

Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them.

Specified by:

setIsDeleteOnExit in interface LeoDelegate

Parameters:

deleteOnExit -

Returns:

reference to the delegate type instance whose flag was set

setParameterSetting

public LeoRemoteAEDescriptor setParameterSetting(String name,
                                                 String value)

Set the remote parameter setting. Parameter names can be found in the gov.va.vinci.leo.LeoRemoteAEDescriptor.Param class.

Parameters:

name - name of the parameter to set

value - String value to which the parameter will be set

Returns:

Reference to the current LeoRemoteAEDescriptor to support the builder pattern

setParameterSetting

public LeoRemoteAEDescriptor setParameterSetting(NameValue nameValue)

Set the remote service parameter from the NameValue pair information provided.

Parameters:

nameValue - NameValue object used to store the parameter name and value

Returns:

Reference to the current LeoRemoteAEDescriptor to support the builder pattern

setParameterSetting

public LeoRemoteAEDescriptor setParameterSetting(org.apache.uima.resource.Parameter p)

Set the remote service parameter from the Parameter name and value information.

Parameters:

p - Parameter object storing the name and value strings to be set

Returns:

Reference to the current LeoRemoteAEDescriptor to support the builder pattern

addParameterSetting

public LeoRemoteAEDescriptor addParameterSetting(String name,
                                                 String value)

Add a new parameter to the descriptor. If the parameter name already exists in the descriptor then the existing parameter is set to the value provided.

Parameters:

name - name of the parameter to add to the descriptor

value - string value of the new parameter

Returns:

Reference to the current LeoRemoteAEDescriptor to support the builder pattern

getParameterSetting

protected org.apache.uima.resource.Parameter getParameterSetting(String name)

Get the Parameter object from the descriptor with the name provided or null if the parameter is not found in the descriptor.

Parameters:

name - string name of the parameter to retrieve

Returns:

reference to the Parameter object with the name provided, null if not found or the name is blank

getParameterValue

protected String getParameterValue(String name)

Get the value of a parameter in the descriptor, returns null if the name is not found in the parameter list.

Parameters:

name - name of the parameter whose value will be returned

Returns:

String representation of the value of the parameter

toXML

public void toXML()
           throws Exception

Description copied from interface: LeoDelegate

Write the descriptor file out based on the locator information in the object. If there is no locator information then a temp file is generated and the location stored.

Specified by:

toXML in interface LeoDelegate

Throws:

Exception - if there is an error serializing the XML

toXML

public void toXML(String filename)
           throws Exception

Description copied from interface: LeoDelegate

Write the descriptor out to a temp XML file with the name provided as the base filename.

Specified by:

toXML in interface LeoDelegate

Parameters:

filename - Base filename for the XML file

Throws:

Exception - if there is an error serializing the XML

analysisEngineSection

public LeoRemoteAEDescriptor analysisEngineSection(TransformerHandler thd,
                                                   boolean isTopDescriptor)
                                            throws SAXException

Produce the Analysis Engine section for the Deployment Descriptor XML.

Specified by:

analysisEngineSection in interface LeoDelegate

Parameters:

thd - TransformerHandler for SAX XML output

isTopDescriptor - if true then this is the top descriptor in the remote deployment

Returns:

Reference to the delegate type object from which the analysisEngineSection was generated

Throws:

SAXException - If there is an error serializing the XML