org.apache.ctakes.core.util

Enum PropertyAeFactory

java.lang.Object

java.lang.Enum<PropertyAeFactory>

org.apache.ctakes.core.util.PropertyAeFactory

All Implemented Interfaces:

Serializable, Comparable<PropertyAeFactory>

public enum PropertyAeFactory
extends Enum<PropertyAeFactory>

This factory can load plain old java .properties files and pass the specified properties as parameters for AE creation. There may be some way to get values directly into the root UimaContext, but for now this works with UimaFit parameters.

Since:

8/8/2016

Version:

%I%

Author:

SPF , chip-nlp

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	addParameters(Object... parameters) Add key value pairs to the stored properties
org.apache.uima.analysis_engine.AnalysisEngineDescription	createDescription(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters)
org.apache.uima.analysis_engine.AnalysisEngine	createEngine(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters) This method should be avoided.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createLoggedDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription mainDescription)
org.apache.uima.analysis_engine.AnalysisEngineDescription	createLoggedDescription(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters)
org.apache.uima.analysis_engine.AnalysisEngine	createLoggedEngine(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters) This method should be avoided.
static PropertyAeFactory	getInstance()
static PropertyAeFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyAeFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final PropertyAeFactory INSTANCE

Method Detail

values

public static PropertyAeFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyAeFactory c : PropertyAeFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyAeFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getInstance

public static PropertyAeFactory getInstance()

addParameters

public void addParameters(Object... parameters)

Add key value pairs to the stored properties

Parameters:

parameters - ket value pairs

createEngine

public org.apache.uima.analysis_engine.AnalysisEngine createEngine(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType,
                                                                   Object... parameters)
                                                            throws org.apache.uima.resource.ResourceInitializationException

This method should be avoided. See the bottom of https://uima.apache.org/d/uimafit-current/api/index.html

Parameters:

classType - main component

parameters - parameters for the main component

Returns:

Engine with specified parameters plus those loaded from properties

Throws:

org.apache.uima.resource.ResourceInitializationException - if UimaFit has a problem

createDescription

public org.apache.uima.analysis_engine.AnalysisEngineDescription createDescription(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType,
                                                                                   Object... parameters)
                                                                            throws org.apache.uima.resource.ResourceInitializationException

Parameters:

classType - main component

parameters - parameters for the main component

Returns:

Description with specified parameters plus those loaded from properties

Throws:

org.apache.uima.resource.ResourceInitializationException - if UimaFit has a problem

createLoggedEngine

public org.apache.uima.analysis_engine.AnalysisEngine createLoggedEngine(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType,
                                                                         Object... parameters)
                                                                  throws org.apache.uima.resource.ResourceInitializationException

This method should be avoided. See the bottom of https://uima.apache.org/d/uimafit-current/api/index.html

Parameters:

classType - main component

parameters - parameters for the main component

Returns:

Engine with specified parameters plus those loaded from properties that is wrapped with a simple Logger AE that logs the Start and Finish of the process

Throws:

org.apache.uima.resource.ResourceInitializationException - if UimaFit has a problem

createLoggedDescription

public org.apache.uima.analysis_engine.AnalysisEngineDescription createLoggedDescription(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType,
                                                                                         Object... parameters)
                                                                                  throws org.apache.uima.resource.ResourceInitializationException

Parameters:

classType - main component

parameters - parameters for the main component

Returns:

Description with specified parameters plus those loaded from properties that is wrapped with a simple Logger AE that logs the Start and Finish of the process

Throws:

org.apache.uima.resource.ResourceInitializationException - if UimaFit has a problem

createLoggedDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createLoggedDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription mainDescription)
                                                                                         throws org.apache.uima.resource.ResourceInitializationException

Parameters:

mainDescription - main component description

Returns:

Description with specified parameters plus those loaded from properties that is wrapped with a simple Logger AE that logs the Start and Finish of the process

Throws:

org.apache.uima.resource.ResourceInitializationException - if UimaFit has a problem