gov.va.vinci.leo.ae

Class ExternalAnnotator

java.lang.Object

gov.va.vinci.leo.ae.ExternalAnnotator

All Implemented Interfaces:

LeoAnnotator

public class ExternalAnnotator
extends Object
implements LeoAnnotator

This annotator is used to import external implementations of annotators by descriptor or directly from the object binary. User: Thomas Ginter Date: 8/8/14 Time: 10:21

Field Summary

Fields

Modifier and Type	Field and Description
protected LeoAEDescriptor	descriptor External descriptor imported to LeoAnnotator for use in the SimplePipeline representation.

Constructor Summary

Constructors

Constructor and Description
ExternalAnnotator(String descriptor, boolean byName, int numInstances, NameValue... paramValues) Create this annotator by importing an external descriptor.
ExternalAnnotator(String descriptor, boolean byName, NameValue... paramValues) Create this annotator by importing an external descriptor.
ExternalAnnotator(String name, String implementation_class) Constructor that creates a blank AnalysisEngineDescriptor object with the name provided.

Method Summary

Modifier and Type	Method and Description
ExternalAnnotator	addTypeSystemDescription(LeoTypeSystemDescription leoTypeSystemDescription) Add the type system provided to the existing type system of this annotator.
LeoDelegate	getDescriptor() Return the Descriptor for this AnalysisEngine or RemoteAnalysisEngine.
LeoTypeSystemDescription	getLeoTypeSystemDescription() Return the type system description for this annotator.
String	getName() Get the name of this annotator.
int	getNumInstances() Number of instances of this annotator in the pipeline.
ExternalAnnotator	setName(String name) Set the name of this annotator.
ExternalAnnotator	setNumInstances(int numInstances) Set the number of instances of this annotator in the pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

protected LeoAEDescriptor descriptor

External descriptor imported to LeoAnnotator for use in the SimplePipeline representation.

Constructor Detail

ExternalAnnotator

public ExternalAnnotator(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.

ExternalAnnotator

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

Create this annotator by importing an external descriptor.

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.

ExternalAnnotator

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

Create this annotator by importing an external descriptor.

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

numInstances - Number of replication instances for this annotator in the pipeline

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.

Method Detail

getNumInstances

public int getNumInstances()

Number of instances of this annotator in the pipeline. Used during asynchronous processing only.

Returns:

Number of instances

setNumInstances

public ExternalAnnotator setNumInstances(int numInstances)

Set the number of instances of this annotator in the pipeline. Used during asynchronous processing.

Parameters:

numInstances - Number of replication instances for this annotator in the pipeline

Returns:

reference to this ExternalAnnotator instance.

getName

public String getName()

Get the name of this annotator.

Returns:

String representation of the annotator name

setName

public ExternalAnnotator setName(String name)

Set the name of this annotator.

Parameters:

name - String representation of the annotator name to set

Returns:

reference to this ExternalAnnotator instance.

getDescriptor

public LeoDelegate getDescriptor()
                          throws Exception

Description copied from interface: LeoAnnotator

Return the Descriptor for this AnalysisEngine or RemoteAnalysisEngine.

Specified by:

getDescriptor in interface LeoAnnotator

Returns:

Descriptor object.

Throws:

Exception - If there is an error generating the descriptor.

getLeoTypeSystemDescription

public LeoTypeSystemDescription getLeoTypeSystemDescription()

Return the type system description for this annotator.

Returns:

LeoTypeSystemDescription set in this annotator descriptor

addTypeSystemDescription

public ExternalAnnotator addTypeSystemDescription(LeoTypeSystemDescription leoTypeSystemDescription)

Add the type system provided to the existing type system of this annotator.

Parameters:

leoTypeSystemDescription - type system to add.

Returns:

Reference to this ExternalAnnotator instance.