gov.va.vinci.leo.descriptors

Class AggregateEngineFactory

java.lang.Object

gov.va.vinci.leo.descriptors.AggregateEngineFactory

public class AggregateEngineFactory
extends Object

Generates elements related to UIMA Aggregate Analysis engines.

Author:

thomasginter

Constructor Summary

Constructors

Constructor and Description
AggregateEngineFactory()

Method Summary

Modifier and Type	Method and Description
protected static void	bindExternalResources(org.apache.uima.analysis_engine.AnalysisEngineDescription aed, org.apache.uima.resource.ResourceCreationSpecifier spec) Bind external resources from the primitive spec to the aggregate AnalysisEngineDescription.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateDescription(List<LeoDelegate> specs, org.apache.uima.flow.FlowControllerDescription flowControllerDescription, String name) Create an aggregate descriptor from a list of LeoAEDescriptor objects.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateDescription(List<LeoDelegate> specs, String name) Create an aggregate descriptor from a list of LeoAEDescriptor objects.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateDescription(String name, List<org.apache.uima.resource.ResourceSpecifier> specs) Create an AnalysisEngineDescription from a name and a list of ResourceCreationSpecifiers each one representing a primitive Analysis engine, CasConsumer, or FlowController.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateDescription(String name, List<String> primitives, boolean byName) Create an AnalysisEngineDescriptor that represents and aggregate analysis engine from a name and a list of primitive engines.
protected static String	getComponentName(org.apache.uima.resource.Parameter[] parameters, String... defaultName) Pull the component name from the list of parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateEngineFactory

public AggregateEngineFactory()

Method Detail

createAggregateDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateDescription(String name,
                                                                                                   List<String> primitives,
                                                                                                   boolean byName)
                                                                                            throws Exception

Create an AnalysisEngineDescriptor that represents and aggregate analysis engine from a name and a list of primitive engines.

Parameters:

name - Name of the AggregateEngine, preferred to be a unique name though not enforced

primitives - List of primitive engine descriptors to be included in the aggregate

byName - Flag that indicates whether or not the list of primitives is to be imported by name or by location, true = import by name

Returns:

AnalysisEngineDescriptor representing an Aggregate engine

Throws:

Exception - thrown if any errors occur

createAggregateDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateDescription(List<LeoDelegate> specs,
                                                                                                   String name)

Create an aggregate descriptor from a list of LeoAEDescriptor objects.

Parameters:

specs - LeoAEDescriptors representing the primitive engines of this aggregate

name - String representation of the name of the aggregate

Returns:

AnalysisEngineDescription representation for the generated aggregate

createAggregateDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateDescription(List<LeoDelegate> specs,
                                                                                                   org.apache.uima.flow.FlowControllerDescription flowControllerDescription,
                                                                                                   String name)

Create an aggregate descriptor from a list of LeoAEDescriptor objects.

Parameters:

specs - LeoAEDescriptors representing the primitive engines of this aggregate

flowControllerDescription - allows the user to specify a custom flow controller

name - String representation of the name of the aggregate

Returns:

AnalysisEngineDescription representation for the generated aggregate

createAggregateDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateDescription(String name,
                                                                                                   List<org.apache.uima.resource.ResourceSpecifier> specs)

Create an AnalysisEngineDescription from a name and a list of ResourceCreationSpecifiers each one representing a primitive Analysis engine, CasConsumer, or FlowController.

Parameters:

name - unique name of the AggregateEngine

specs - List of primitive Engine Descriptors to be included in the aggregate

Returns:

AnalysisEngineDescription representing an Aggregate engine

bindExternalResources

protected static void bindExternalResources(org.apache.uima.analysis_engine.AnalysisEngineDescription aed,
                                            org.apache.uima.resource.ResourceCreationSpecifier spec)

Bind external resources from the primitive spec to the aggregate AnalysisEngineDescription.

Parameters:

aed - Aggregate AnalysisEngineDescription to bind resources into

spec - primitive engine spec to bind resources from

getComponentName

protected static String getComponentName(org.apache.uima.resource.Parameter[] parameters,
                                         String... defaultName)

Pull the component name from the list of parameters. If the name is not listed then generate one in the format: leoRemoteDelegate2112{UUID}

Parameters:

parameters - Array of Parameter objects

Returns:

component name string