gov.va.vinci.leo.descriptors

Interface LeoDelegate

All Known Implementing Classes:

LeoAEDescriptor, LeoPearDescriptor, LeoRemoteAEDescriptor

public interface LeoDelegate

Common API interface for Remote and Local Analysis Engine Delegates. User: Thomas Ginter Date: 10/30/13 Time: 1:29 PM

Method Summary

Modifier and Type	Method and Description
<T extends LeoDelegate> T	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.
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.
<T extends LeoDelegate> T	setDescriptorLocator(URI descriptorLocator) Set the location where the descriptor should be generated.
<T extends LeoDelegate> T	setIsDeleteOnExit(boolean deleteOnExit) Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them.
<T extends LeoDelegate> T	setName(String name) Set the name of this delegate, return a reference to the delegate type object in each implementation.
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.

Method Detail

getResourceSpecifier

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.

Returns:

ResourceSpecifier object for this delegate

setDescriptorLocator

<T extends LeoDelegate> T 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.

Type Parameters:

T - reference to this LeoAEDescriptor object instance for builder pattern

Parameters:

descriptorLocator - URI path where the descriptors should be located

Returns:

reference to the delegate type whose name is set

getDescriptorLocator

String getDescriptorLocator()

Returns:

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

getName

String getName()

Get the name of this delegate.

Returns:

String representing the name of this delegate

setName

<T extends LeoDelegate> T setName(String name)
                           throws IOException

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

Type Parameters:

T - delegate return type

Parameters:

name - String name of the delegate to set

Returns:

reference to the delegate type whose name is set

Throws:

IOException - if there is an error setting the name of the delegate descriptor

isDeleteOnExit

boolean isDeleteOnExit()

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

Returns:

TRUE if descriptors will be deleted

setIsDeleteOnExit

<T extends LeoDelegate> T setIsDeleteOnExit(boolean deleteOnExit)

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

Type Parameters:

T - Generic type template for extending classes.

Parameters:

deleteOnExit - true if the descriptors should auto delete

Returns:

reference to the delegate type instance whose flag was set

toXML

void toXML()
    throws Exception

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.

Throws:

Exception - if there is an error serializing the XML

toXML

void toXML(String filename)
    throws Exception

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

Parameters:

filename - Base filename for the XML file

Throws:

Exception - if there is an error serializing the XML

analysisEngineSection

<T extends LeoDelegate> T analysisEngineSection(TransformerHandler thd,
                                                boolean isTopDescriptor)
                                         throws SAXException

Produce the Analysis Engine section for the Deployment Descriptor XML.

Type Parameters:

T - Generic type template for extending classes.

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