gov.va.vinci.leo.descriptors

Class LeoPearDescriptor

java.lang.Object

gov.va.vinci.leo.descriptors.LeoPearDescriptor

All Implemented Interfaces:

LeoDelegate

public class LeoPearDescriptor
extends Object
implements LeoDelegate

Created by tginter on 7/6/17.

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	descriptorLocator
protected org.apache.uima.resource.PearSpecifier	resourceSpecifier

Constructor Summary

Constructors

Constructor and Description
LeoPearDescriptor(File pearDescFile)
LeoPearDescriptor(String pearDescPath)
LeoPearDescriptor(URI pearDescFile)

Method Summary

Modifier and Type	Method and Description
LeoPearDescriptor	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.
LeoPearDescriptor	setDescriptorLocator(URI descriptorLocator) Set the location where the descriptor should be generated.
LeoPearDescriptor	setIsDeleteOnExit(boolean deleteOnExit) Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them.
LeoPearDescriptor	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.

Methods inherited from class java.lang.Object

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

Field Detail

resourceSpecifier

protected org.apache.uima.resource.PearSpecifier resourceSpecifier

descriptorLocator

protected URI descriptorLocator

Constructor Detail

LeoPearDescriptor

public LeoPearDescriptor(String pearDescPath)
                  throws IOException,
                         org.apache.uima.util.InvalidXMLException

Throws:

IOException

org.apache.uima.util.InvalidXMLException

LeoPearDescriptor

public LeoPearDescriptor(File pearDescFile)
                  throws IOException,
                         org.apache.uima.util.InvalidXMLException

Throws:

IOException

org.apache.uima.util.InvalidXMLException

LeoPearDescriptor

public LeoPearDescriptor(URI pearDescFile)
                  throws IOException,
                         org.apache.uima.util.InvalidXMLException

Throws:

IOException

org.apache.uima.util.InvalidXMLException

Method Detail

getResourceSpecifier

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

Description copied from interface: LeoDelegate

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 LeoPearDescriptor setDescriptorLocator(URI descriptorLocator)

Description copied from interface: LeoDelegate

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 the delegate type whose name is set

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()

Description copied from interface: LeoDelegate

Get the name of this delegate.

Specified by:

getName in interface LeoDelegate

Returns:

String representing the name of this delegate

setName

public LeoPearDescriptor setName(String name)
                          throws IOException

Description copied from interface: LeoDelegate

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

Specified by:

setName in interface LeoDelegate

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

public boolean isDeleteOnExit()

Description copied from interface: LeoDelegate

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 LeoPearDescriptor setIsDeleteOnExit(boolean deleteOnExit)

Description copied from interface: LeoDelegate

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 - true if the descriptors should auto delete

Returns:

reference to the delegate type instance whose flag was set

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 LeoPearDescriptor analysisEngineSection(TransformerHandler thd,
                                               boolean isTopDescriptor)
                                        throws SAXException

Description copied from interface: LeoDelegate

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