gov.va.vinci.leo.descriptors

Class LeoAEDescriptor

java.lang.Object

gov.va.vinci.leo.descriptors.LeoAEDescriptor

All Implemented Interfaces:

LeoDelegate

public class LeoAEDescriptor
extends Object
implements LeoDelegate

Allows the user to easily modify and create an AnalysisEngineDescriptor object without needing to directly access the UIMA API.

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUMBER_INSTANCES Default number of replication instances for this AnalysisEngine.
protected boolean	deleteOnExit If TRUE then delete the generated descriptor file once the program exits, defaults to TRUE.
static org.apache.log4j.Logger	LOG Logging object of output.
protected org.apache.uima.analysis_engine.AnalysisEngineDescription	mAEDescriptor AnalysisEngineDescription reference object.
protected ArrayList<String>	mDelegateNames Names of the delegate engines for aggregates only.
protected ArrayList<LeoDelegate>	mDelegates Delegate AnalysisEngineDescriptors for aggregates only.
protected URI	mDescriptorLocator The locator for this descriptor.
protected org.apache.uima.analysis_engine.metadata.FlowConstraints	mFlowConstraints Flow constraints for aggregates not using a fixed flow.
protected boolean	mIsAsync For an aggregate engine deployment will this aggregate be executed asynchronously, if false (default) then the engine will be executed and scaled as a unit, if true then the delegate engines will each be scaled individually.
protected int	mNumberOfInstances The number of instances of this Engine to execute in parellel on the service.

Constructor Summary

Constructors

Constructor and Description
LeoAEDescriptor() Default constructor.
LeoAEDescriptor(org.apache.uima.analysis_engine.AnalysisEngineDescription aed) Use an existing AnalysisEngineDescription object to create a new LeoAEDescriptor.
LeoAEDescriptor(List<LeoAEDescriptor> primitives) Create a new LeoAEDescriptor object that represents an aggregate from a list of LeoAEDescriptor primitives.
LeoAEDescriptor(String descriptor, boolean byName, NameValue... paramValues) Create a new description object from the descriptor file provided.
LeoAEDescriptor(String name, String implementation_class) Constructor that creates a blank AnalysisEngineDescriptor object with the name provided.

Method Summary

Modifier and Type	Method and Description
LeoAEDescriptor	addCapability(org.apache.uima.resource.metadata.Capability c) Adds either outputs or inputs for the specified capability to this ResultSpecification.
LeoAEDescriptor	addConfigurationParameter(org.apache.uima.resource.metadata.ConfigurationParameter aConfigurationParameter) Adds a configuration parameter to the metadata for this AnalysisEngineDescriptor.
LeoAEDescriptor	addDelegate(LeoDelegate delegate) Add the provided LeoAEDescriptor as a delegate to this AnalysisEngine.
LeoAEDescriptor	addDelegate(String descriptor, boolean byName, NameValue... paramValues) Add a delegate analysis engine descriptor to this engine using the descriptor provided.
LeoAEDescriptor	addParameterSetting(String paramName, boolean isMandatory, boolean isMultiValued, String paramType) Add a new parameter.
LeoAEDescriptor	addParameterSetting(String paramName, boolean isMandatory, boolean isMultiValued, String paramType, Object initValue) Add a new parameter and optionally set an initial value.
LeoAEDescriptor	addResourceConfiguration(org.apache.uima.resource.metadata.ResourceManagerConfiguration rmc) Add the external resources specified by the provided ResourceManagerConfiguration object.
LeoAEDescriptor	addType(String aTypeName, String aTypeDescription, String aSuperTypeName) Add a new type to the TypeSystem with the Name and SuperType name provided.
LeoAEDescriptor	addType(org.apache.uima.resource.metadata.TypeDescription td) Add an Annotation Type to the TypeSystem.
LeoAEDescriptor	addTypeSystemDescription(LeoTypeSystemDescription ftsd) Append the TypeSystem contained in a LeoTypeSystemDescription object to the TypeSystem contained in this Analysis Engine.
LeoAEDescriptor	addTypeSystemDescription(org.apache.uima.resource.metadata.TypeSystemDescription tsd) Append an existing TypeSystem to the existing TypeSystem contained in this Analysis Engine.
LeoAEDescriptor	analysisEngineSection(TransformerHandler thd, boolean isTopDescriptor) Generate the XML for the analysisEngine section of the deployment descriptor.
LeoAEDescriptor	genTypeSystemJava(String srcDirectory, String binDirectory) Generate the java source files for the TypeSystem of this AnalysisEngine, then compile them.
protected org.apache.uima.analysis_engine.AnalysisEngineDescription	getAEDescriptor() Return an AnalysisEngineDescription object reference for this model.
org.apache.uima.analysis_engine.AnalysisEngineDescription	getAnalysisEngineDescription() Get a reference to the core AnalysisEngineDescription object that this LeoAEDescriptor uses.
org.apache.uima.resource.metadata.Capability[]	getCapabilites() Get the capabilities for this Analysis Engine from its metadata.
LeoDelegate	getDelegate(String name) Get a LeoAEDescriptor for a delegate engine with the name provided.
List<String>	getDelegateNames() Return the names of the delegates found in aggregate descriptors.
LeoDelegate[]	getDelegates() Get the set of delegate engines for this aggregate if it exists.
String	getDescription() Gets the description of this Resource.
String	getDescriptorLocator()
String	getImplementationName() Retrieves the name of this ResourceCreationSpecifier's implementation.
int	getMaxNumberOfInstances()
boolean	getModifiesCas() Gets whether this component will modify the CAS.
String	getName() Gets the name of this Resource.
int	getNumberOfInstances()
boolean	getOutputsNewCASes() Gets whether this AnalysisEngine may output new CASes.
Object	getParameterValue(String paramName) Return the value to which the parameter has been set.
org.apache.uima.resource.ResourceSpecifier	getResourceSpecifier() Return a reference to the internal ResourceSpecifier that is the backend model for the delegate.
LeoTypeSystemDescription	getTypeSystemDescription() A simple method for getting the hold of current Type System.
String	getVersion() Sets the version number of this Resource.
boolean	isAggregate()
boolean	isAsync()
boolean	isDeleteOnExit() Returns TRUE if the generated descriptors will be deleted when the program exits.
boolean	isMultipleDeploymentAllowed() Gets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.
boolean	isPrimitive() Retrieves whether the AnalysisEngine is primitive (consisting of one annotator), as opposed to aggregate (containing multiple delegate AnalysisEngines).
protected void	setAEDescriptor(org.apache.uima.analysis_engine.AnalysisEngineDescription aed) Assign the AnalysisEngineDescription model for this LeoAEDescriptor object.
LeoAEDescriptor	setAnalysisEngineDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription aed) Set the AnalysisEngineDescription object that will be the core gov.va.vinci.leo.model for this LeoAEDescriptor.
LeoAEDescriptor	setAnalysisEngineDescription(String descriptor, boolean byName) Generate the AnalysisEngineDescription object from the descriptor file and set it as the internal gov.va.vinci.leo.model for this LeoAEDescriptor.
LeoAEDescriptor	setDescription(String desc) Sets the description of this Resource.
LeoAEDescriptor	setDescriptorLocator(URI mDescriptorLocator) Set the location where the descriptor should be generated.
LeoAEDescriptor	setImplementationName(String s) Sets the name of this ResourceCreationSpecifier's implementation.
LeoAEDescriptor	setIsAsync(boolean async) Set the async flag for an aggregate deployment only, see the isAsync method for more information about flag usage.
LeoAEDescriptor	setIsDeleteOnExit(boolean deleteOnExit) Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them.
LeoAEDescriptor	setModifiesCas(boolean aModifiesCas) Sets whether this component will modify the CAS.
LeoAEDescriptor	setMultipleDeploymentAllowed(boolean b) Sets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.
LeoAEDescriptor	setName(String name) Sets the name of this Resource.
LeoAEDescriptor	setNumberOfInstances(int numberOfInstances)
LeoAEDescriptor	setOutputsNewCASes(boolean b) Sets whether this AnalysisEngine may output new CASes.
LeoAEDescriptor	setParameterSetting(NameValue fpv) Set a parameter from a NameValue object.
LeoAEDescriptor	setParameterSetting(String name, Object value) Set the parameter with the name to the value.
LeoAEDescriptor	setTypeSystemDescription(LeoTypeSystemDescription ftsd) This method sets the type system description for this analysis engine to the TypeSystem provided.
LeoAEDescriptor	setTypeSystemDescription(org.apache.uima.resource.metadata.TypeSystemDescription tsd) Set the type system description for this analysis engine to the TypeSystem provided.
LeoAEDescriptor	setVersion(String version) Sets the version number of this Resource.
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 filename.
protected void	validParamType(String paramType) Test the Parameter Type string to make sure it is not null or empty and it is one of the defined type constants defined in the ConfigurationParameter interface.

Methods inherited from class java.lang.Object

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

Field Detail

mAEDescriptor

protected org.apache.uima.analysis_engine.AnalysisEngineDescription mAEDescriptor

AnalysisEngineDescription reference object.

mDelegates

protected ArrayList<LeoDelegate> mDelegates

Delegate AnalysisEngineDescriptors for aggregates only.

mDelegateNames

protected ArrayList<String> mDelegateNames

Names of the delegate engines for aggregates only.

mFlowConstraints

protected org.apache.uima.analysis_engine.metadata.FlowConstraints mFlowConstraints

Flow constraints for aggregates not using a fixed flow.

mIsAsync

protected boolean mIsAsync

For an aggregate engine deployment will this aggregate be executed asynchronously, if false (default) then the engine will be executed and scaled as a unit, if true then the delegate engines will each be scaled individually.

mNumberOfInstances

protected int mNumberOfInstances

The number of instances of this Engine to execute in parellel on the service. Aggregate engines with async=false must be set to 1 for the number of instances.

mDescriptorLocator

protected URI mDescriptorLocator

The locator for this descriptor.

deleteOnExit

protected boolean deleteOnExit

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

LOG

public static final org.apache.log4j.Logger LOG

Logging object of output.

DEFAULT_NUMBER_INSTANCES

public static final int DEFAULT_NUMBER_INSTANCES

Default number of replication instances for this AnalysisEngine.

See Also:

Constant Field Values

Constructor Detail

LeoAEDescriptor

public LeoAEDescriptor()

Default constructor. Just gets a blank AnalysisEngineDescriptor object from the factory.

LeoAEDescriptor

public LeoAEDescriptor(String name,
                       String implementation_class)

Constructor that creates a blank AnalysisEngineDescriptor object with the name provided. Also sets the implementation class name to the implementation_class string provided.

Parameters:

name - the name of the AnalysisEngine, Leo will make sure it is unique.

implementation_class - the fully qualified name of the Annotator Class.

LeoAEDescriptor

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

Create a new description object from the descriptor file provided.

Parameters:

descriptor - path or name of a descriptor file used to generate the AED

byName - if true then try to import by name otherwise import by location

paramValues - Optional, list of parameters names and values to set. Creates the parameter if it does not already exist.

Throws:

IOException - if the descriptor cannot created.

org.apache.uima.util.InvalidXMLException - if there is a problem creating the xml.

LeoAEDescriptor

public LeoAEDescriptor(List<LeoAEDescriptor> primitives)

Create a new LeoAEDescriptor object that represents an aggregate from a list of LeoAEDescriptor primitives.

Parameters:

primitives - List of primitives to be included in the aggregate

LeoAEDescriptor

public LeoAEDescriptor(org.apache.uima.analysis_engine.AnalysisEngineDescription aed)

Use an existing AnalysisEngineDescription object to create a new LeoAEDescriptor.

Parameters:

aed - AnalysisEngineDescription object used to store the metadata for this descriptor

Method Detail

setAEDescriptor

protected void setAEDescriptor(org.apache.uima.analysis_engine.AnalysisEngineDescription aed)

Assign the AnalysisEngineDescription model for this LeoAEDescriptor object. For aggregates we also get the delegates and assign them within each map.

Parameters:

aed - AnalysisEngineDescription object

getAEDescriptor

protected org.apache.uima.analysis_engine.AnalysisEngineDescription getAEDescriptor()

Return an AnalysisEngineDescription object reference for this model. If this is an aggregate engine then combine the delegates into a new descriptor in case delegate params have been set.

Returns:

AnalysisEngineDescription object

addDelegate

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

Add a delegate analysis engine descriptor to this engine using the descriptor provided. Optionally the user can also set parameter values in the delegate.

Parameters:

descriptor - Name or path to the delegate descriptor to be added.

byName - If true import this descriptor by name, else assume the descriptor param is a path

paramValues - Optional, parameter values to be set in the delegate descriptor

Returns:

this Leo AE Descriptor object.

Throws:

IOException - if the descriptor cannot be read.

org.apache.uima.util.InvalidXMLException - if there is a problem creating the xml.

addDelegate

public LeoAEDescriptor addDelegate(LeoDelegate delegate)

Add the provided LeoAEDescriptor as a delegate to this AnalysisEngine.

Parameters:

delegate - Delegate to be added.

Returns:

this Leo AE Descriptor object.

getDelegate

public LeoDelegate getDelegate(String name)

Get a LeoAEDescriptor for a delegate engine with the name provided.

Parameters:

name - Annotator delegate name

Returns:

Delegate LeoAEDescriptor with name or null if not found

getDelegates

public LeoDelegate[] getDelegates()

Get the set of delegate engines for this aggregate if it exists.

Returns:

LeoAEDescriptor array of delegate engines or null if no delegates are found

getDelegateNames

public List<String> getDelegateNames()

Return the names of the delegates found in aggregate descriptors. If no names have been set then returns null.

Returns:

list of delegate names or null if no names are found.

setAnalysisEngineDescription

public LeoAEDescriptor setAnalysisEngineDescription(String descriptor,
                                                    boolean byName)
                                             throws IOException,
                                                    org.apache.uima.util.InvalidXMLException

Generate the AnalysisEngineDescription object from the descriptor file and set it as the internal gov.va.vinci.leo.model for this LeoAEDescriptor.

Parameters:

descriptor - file used to generate the AnalysisEngineDescription object

byName - if true import the descriptor by name otherwise import by location

Returns:

this Leo AE Descriptor object.

Throws:

IOException - if the descriptor cannot created.

org.apache.uima.util.InvalidXMLException - if there is a problem creating the xml.

setAnalysisEngineDescription

public LeoAEDescriptor setAnalysisEngineDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription aed)

Set the AnalysisEngineDescription object that will be the core gov.va.vinci.leo.model for this LeoAEDescriptor.

Parameters:

aed - The AnalysisEngineDescription object

Returns:

this Leo AE Descriptor object.

getAnalysisEngineDescription

public org.apache.uima.analysis_engine.AnalysisEngineDescription getAnalysisEngineDescription()

Get a reference to the core AnalysisEngineDescription object that this LeoAEDescriptor uses.

Returns:

an AnalysisEngineDescription object

setParameterSetting

public LeoAEDescriptor setParameterSetting(String name,
                                           Object value)

Set the parameter with the name to the value.

Parameters:

name - String representing the parameter to be set

value - Object that is the value of this parameter

Returns:

this Leo AE Descriptor object.

setParameterSetting

public LeoAEDescriptor setParameterSetting(NameValue fpv)

Set a parameter from a NameValue object. Set create to true if this method should create a parameter if it does not exist.

Parameters:

fpv - Parameter name and value to be set

Returns:

this Leo AE Descriptor object.

addParameterSetting

public LeoAEDescriptor addParameterSetting(String paramName,
                                           boolean isMandatory,
                                           boolean isMultiValued,
                                           String paramType)
                                    throws Exception

Add a new parameter. If a parameter already exists with the same name then the optional value is set.

Parameters:

paramName - Name of the parameter to be created

isMandatory - If True then this parameter is required, false otherwise

isMultiValued - If True then this parameter is multi-valued (an Array), false otherwise

paramType - The data type of the parameter, i.e. String, Boolean, etc.

Returns:

this Leo AE Descriptor object.

Throws:

Exception - Thrown if the parameter cannot be set with the optional value or an required argument is missing

addParameterSetting

public LeoAEDescriptor addParameterSetting(String paramName,
                                           boolean isMandatory,
                                           boolean isMultiValued,
                                           String paramType,
                                           Object initValue)
                                    throws Exception

Add a new parameter and optionally set an initial value. If a parameter already exists with the same name then the optional value is set.

Parameters:

paramName - Name of the parameter to be created

isMandatory - If True then this parameter is required, false otherwise

isMultiValued - If True then this parameter is multi-valued (an Array), false otherwise

paramType - The data type of the parameter, i.e. String, Boolean, etc.

initValue - Optional, the initial value to set for this parameter

Returns:

this Leo AE Descriptor object.

Throws:

Exception - Thrown if the parameter cannot be set with the optional value or an required argument is missing

validParamType

protected void validParamType(String paramType)
                       throws Exception

Test the Parameter Type string to make sure it is not null or empty and it is one of the defined type constants defined in the ConfigurationParameter interface.

Parameters:

paramType - The parameter Type string to be validated

Throws:

Exception - Thrown if the type string is empty or null or is not one of the type constants defined in the ConfigurationParameter interface.

addConfigurationParameter

public LeoAEDescriptor addConfigurationParameter(org.apache.uima.resource.metadata.ConfigurationParameter aConfigurationParameter)

Adds a configuration parameter to the metadata for this AnalysisEngineDescriptor.

Parameters:

aConfigurationParameter - UIMA ConfigurationParameter to add

Returns:

this Leo AE Descriptor object.

getParameterValue

public Object getParameterValue(String paramName)

Return the value to which the parameter has been set.

Parameters:

paramName - The name of the parameter whose value will be returned

Returns:

Parameter value or null if the value cannot be retrieved.

addType

public LeoAEDescriptor addType(String aTypeName,
                               String aTypeDescription,
                               String aSuperTypeName)
                        throws Exception

Add a new type to the TypeSystem with the Name and SuperType name provided.

Parameters:

aTypeName - Name of the new Type to be added to the TypeSystem

aTypeDescription - Description of the new Type to be added

aSuperTypeName - Name of the SuperType from which this type will derive

Returns:

this Leo AE Descriptor object.

Throws:

Exception - If the required parameters, aTypeName or aSuperTypeName are missing.

addType

public LeoAEDescriptor addType(org.apache.uima.resource.metadata.TypeDescription td)

Add an Annotation Type to the TypeSystem. Return a reference pointer to this LeoAEDescriptor object.

Parameters:

td - TypeDescription to add to the TypeSystem

Returns:

this Leo AE Descriptor object.

addTypeSystemDescription

public LeoAEDescriptor addTypeSystemDescription(LeoTypeSystemDescription ftsd)

Append the TypeSystem contained in a LeoTypeSystemDescription object to the TypeSystem contained in this Analysis Engine.

Parameters:

ftsd - LeoTypeSystemDescription to add to this TypeSystem.

Returns:

this Leo AE Descriptor object.

addTypeSystemDescription

public LeoAEDescriptor addTypeSystemDescription(org.apache.uima.resource.metadata.TypeSystemDescription tsd)

Append an existing TypeSystem to the existing TypeSystem contained in this Analysis Engine.

Parameters:

tsd - TypeSystemDescription to append to the existing one.

Returns:

this Leo AE Descriptor object.

setTypeSystemDescription

public LeoAEDescriptor setTypeSystemDescription(LeoTypeSystemDescription ftsd)

This method sets the type system description for this analysis engine to the TypeSystem provided.

Parameters:

ftsd - LeoTypeSystemDescription to be used in this analysis engine

Returns:

this Leo AE Descriptor object.

setTypeSystemDescription

public LeoAEDescriptor setTypeSystemDescription(org.apache.uima.resource.metadata.TypeSystemDescription tsd)

Set the type system description for this analysis engine to the TypeSystem provided.

Parameters:

tsd - TypeSystemDescription to be used for this analysis engine

Returns:

this Leo AE Descriptor object.

getTypeSystemDescription

public LeoTypeSystemDescription getTypeSystemDescription()

A simple method for getting the hold of current Type System.

Returns:

the type system for this descriptor.

genTypeSystemJava

public LeoAEDescriptor genTypeSystemJava(String srcDirectory,
                                         String binDirectory)
                                  throws Exception

Generate the java source files for the TypeSystem of this AnalysisEngine, then compile them.

Parameters:

srcDirectory - Directory where the java source files will be generated into

binDirectory - Directory path where the .class files will be generated

Returns:

this Leo AE Descriptor object.

Throws:

Exception - If we are unable to generate the java files or there is a compilation error

isAsync

public boolean isAsync()

Returns:

boolean async flag for aggregate engines if true then delegates are scaled individually if false (default) then aggregate is scaled as a whole

setIsAsync

public LeoAEDescriptor setIsAsync(boolean async)

Set the async flag for an aggregate deployment only, see the isAsync method for more information about flag usage. This method also changes the name to "aggregate" if async is set to true.

Parameters:

async - If this is a primitive, async will be set to false, otherwise it will be set to async.

Returns:

this Leo AE Descriptor object.

isAggregate

public boolean isAggregate()

Returns:

true if this is an aggregate engine or false if primitive

getNumberOfInstances

public int getNumberOfInstances()

Returns:

the NumberOfInstances to scale this deployment into

setNumberOfInstances

public LeoAEDescriptor setNumberOfInstances(int numberOfInstances)

Parameters:

numberOfInstances - the NumberOfInstances to scale this engine

Returns:

this Leo AE Descriptor object.

getMaxNumberOfInstances

public int getMaxNumberOfInstances()

Returns:

the max number of instances for this engine and any delegates

setDescriptorLocator

public LeoAEDescriptor setDescriptorLocator(URI mDescriptorLocator)

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. This method should never be called directly by the user as settings are propagated from the service object and will be overridden. Descriptor location can be set in the service object using Service.setDescriptorDirectory("my/desc/dir").

Specified by:

setDescriptorLocator in interface LeoDelegate

Parameters:

mDescriptorLocator - URI path where the descriptors should be located

Returns:

reference to this LeoAEDescriptor object instance for builder pattern

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.

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

toXML

public void toXML(String filename)
           throws Exception

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

Specified by:

toXML in interface LeoDelegate

Parameters:

filename - the filename to write out to. Note: the name is used in creating a temp file with the .xml suffix, so name should just be the root filename with a path or extension.

Throws:

Exception - if the xml cannot be written out to the specified file

toXML

public void toXML()
           throws IOException,
                  SAXException,
                  org.apache.uima.util.InvalidXMLException,
                  URISyntaxException

Write the descriptor file out based on the locator information in the object. If no locator information has been set then we generate a temp file.

Specified by:

toXML in interface LeoDelegate

Throws:

IOException - if the file cannot be written to

SAXException - if there is a problem creating the xml

org.apache.uima.util.InvalidXMLException - if the xml is invalid.

URISyntaxException - if the path specified is invalid.

analysisEngineSection

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

Generate the XML for the analysisEngine section of the deployment descriptor.

Specified by:

analysisEngineSection in interface LeoDelegate

Parameters:

thd - the xml transform handler.

isTopDescriptor - true if this is a top level descriptor, else false.

Returns:

this Leo AE Descriptor

Throws:

SAXException - if there is no descriptor to output

isPrimitive

public boolean isPrimitive()

Retrieves whether the AnalysisEngine is primitive (consisting of one annotator), as opposed to aggregate (containing multiple delegate AnalysisEngines).

Returns:

true if this is a primitive, else false.

setImplementationName

public LeoAEDescriptor setImplementationName(String s)

Sets the name of this ResourceCreationSpecifier's implementation. This must be a fully qualified Java class name.

Parameters:

s - the implementation name of the Annotator

Returns:

this Leo AE Descriptor object.

getImplementationName

public String getImplementationName()

Retrieves the name of this ResourceCreationSpecifier's implementation. This must be a fully qualified Java class name.

Returns:

the implementation name of the CasConsumer

setDescription

public LeoAEDescriptor setDescription(String desc)

Sets the description of this Resource.

Parameters:

desc - the description of this Resource

Returns:

this Leo AE Descriptor object.

getDescription

public String getDescription()

Gets the description of this Resource.

Returns:

the description of this Resource

setName

public LeoAEDescriptor setName(String name)

Sets the name of this Resource.

Specified by:

setName in interface LeoDelegate

Parameters:

name - the name of this Resource

Returns:

this Leo AE Descriptor object.

getName

public String getName()

Gets the name of this Resource.

Specified by:

getName in interface LeoDelegate

Returns:

the name of this Resource

setVersion

public LeoAEDescriptor setVersion(String version)

Sets the version number of this Resource.

Parameters:

version - he version number of this Resource, as a String

Returns:

this Leo AE Descriptor object.

getVersion

public String getVersion()

Sets the version number of this Resource.

Returns:

the version number of this Resource, as a String

setModifiesCas

public LeoAEDescriptor setModifiesCas(boolean aModifiesCas)

Sets whether this component will modify the CAS.

Parameters:

aModifiesCas - true if this component modifies the CAS, false if it does not.

Returns:

this Leo AE Descriptor object.

getModifiesCas

public boolean getModifiesCas()

Gets whether this component will modify the CAS.

Returns:

true if this component modifies the CAS, false if it does not.

setMultipleDeploymentAllowed

public LeoAEDescriptor setMultipleDeploymentAllowed(boolean b)

Sets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.

Parameters:

b - true if multiple instances can be run in parallel, false if not

Returns:

this Leo AE Descriptor object.

isMultipleDeploymentAllowed

public boolean isMultipleDeploymentAllowed()

Gets whether multiple instances of this component can be run in parallel, each receiving a subset of the documents from a collection.

Returns:

true if multiple instances can be run in parallel, false if not

setOutputsNewCASes

public LeoAEDescriptor setOutputsNewCASes(boolean b)

Sets whether this AnalysisEngine may output new CASes. If this property is set to true, an application can use the AnalysisEngine.processAndOutputNewCASes(CAS) to pass a CAS to this this AnalysisEngine and then step through all of the output CASes that it produces. For example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a separate CAS.

Parameters:

b - true if this component may output new CASes, false if it does not

Returns:

this Leo AE Descriptor object.

getOutputsNewCASes

public boolean getOutputsNewCASes()

Gets whether this AnalysisEngine may output new CASes. If this property is set to true, an application can use the AnalysisEngine.processAndOutputNewCASes(CAS) to pass a CAS to this this AnalysisEngine and then step through all of the output CASes that it produces. For example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a separate CAS.

Returns:

true if this component may output new CASes, false if it does not

addCapability

public LeoAEDescriptor addCapability(org.apache.uima.resource.metadata.Capability c)

Adds either outputs or inputs for the specified capability to this ResultSpecification.

Parameters:

c - capability to add.

Returns:

this Leo AE Descriptor object.

getCapabilites

public org.apache.uima.resource.metadata.Capability[] getCapabilites()

Get the capabilities for this Analysis Engine from its metadata.

Returns:

the array of capabilities, or an empty array if there are no capabilities.

addResourceConfiguration

public LeoAEDescriptor addResourceConfiguration(org.apache.uima.resource.metadata.ResourceManagerConfiguration rmc)

Add the external resources specified by the provided ResourceManagerConfiguration object.

Parameters:

rmc - ResourceManagerConfiguration object with external resources to bind

Returns:

this Leo AE Descriptor object.

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

Set the flag to TRUE if generated descriptors should be deleted when the program exits, FALSE to persist them. This method should never be called directly by the user. The delete on exit flag is propagated from the Service object and should be set in the Service.setDeleteOnExit(true) method.

Specified by:

setIsDeleteOnExit in interface LeoDelegate

Parameters:

deleteOnExit -

Returns:

reference to the delegate type instance whose flag was set