org.apache.ctakes.core.ae

Class StartFinishLogger

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

org.apache.ctakes.core.ae.StartFinishLogger

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

@PipeBitInfo(name="Start or Finish Logger",
             description="Simple Annotator to place before and after other annotators that do not Log their Start and Finish.",
             role=SPECIAL)
public class StartFinishLogger
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

All Annotation Engines should be logger their start and finish. Such logging not only keeps track of what is actually in the pipeline, but it also helps with debugging and profiling

Since:

8/8/2016

Version:

%I%

Author:

SPF , chip-nlp

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_IS_START
static String	PARAM_LOGGER_NAME

Constructor Summary

Constructors

Constructor and Description
StartFinishLogger()

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createDescription(String loggerName, boolean isStart)
static org.apache.uima.analysis_engine.AnalysisEngine	createEngine(String loggerName, boolean isStart) This method should be avoided.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createLoggedDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription mainDescription)
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createLoggedDescription(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters)
static org.apache.uima.analysis_engine.AnalysisEngine	createLoggedEngine(Class<? extends org.apache.uima.analysis_component.AnalysisComponent> classType, Object... parameters) This method should be avoided.
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas jcas)

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_LOGGER_NAME

public static final String PARAM_LOGGER_NAME

See Also:

Constant Field Values

PARAM_IS_START

public static final String PARAM_IS_START

See Also:

Constant Field Values

Constructor Detail

StartFinishLogger

public StartFinishLogger()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas jcas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

createEngine

public static org.apache.uima.analysis_engine.AnalysisEngine createEngine(String loggerName,
                                                                          boolean isStart)
                                                                   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:

loggerName - name for the logger

isStart - true to return an Engine that logs the Start, false to return an Engine that logs Finish

Returns:

Simple Start/Finish Logger Engine

Throws:

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

createDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createDescription(String loggerName,
                                                                                          boolean isStart)
                                                                                   throws org.apache.uima.resource.ResourceInitializationException

Parameters:

loggerName - name for the logger

isStart - true to return an Engine that logs the Start, false to return an Engine that logs Finish

Returns:

Simple Start/Finish Logger Engine

Throws:

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

createLoggedEngine

public static 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 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(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 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 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