de.tudarmstadt.ukp.dkpro.core.api.featurepath

Class FeaturePathAnnotatorBase

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

de.tudarmstadt.ukp.dkpro.core.api.featurepath.FeaturePathAnnotatorBase

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

CisStemmer, LancasterStemmer, SnowballStemmer

public abstract class FeaturePathAnnotatorBase
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

Field Summary

Fields

Modifier and Type	Field and Description
protected Condition	filterCondition
protected String	filterConditionOperator
protected String	filterConditionValue
protected String	filterFeaturePath
protected FeaturePathInfo	filterFeaturePathInfo
protected FeaturePathInfo	fp
static String	PARAM_FILTER_CONDITION_OPERATOR Specifies the operator for a filtering condition.
static String	PARAM_FILTER_CONDITION_VALUE Specifies the value for a filtering condition.
static String	PARAM_FILTER_FEATUREPATH Specifies a feature path that is used in the filter.
static String	PARAM_PATHS Specify a path that is used for annotation.
protected Set<String>	paths

Constructor Summary

Constructors

Constructor and Description
FeaturePathAnnotatorBase()

Method Summary

Modifier and Type	Method and Description
protected abstract void	generateAnnotations(org.apache.uima.jcas.JCas jcas) Method to create annotations.
protected Set<String>	getDefaultPaths()
void	initialize(org.apache.uima.UimaContext aContext)
void	initializeFeaturePathInfoFrom(FeaturePathInfo aFp, String[] featurePathString) Checks for empty feature path and initializes the feature path object.
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_PATHS

public static final String PARAM_PATHS

Specify a path that is used for annotation. Format is de.type.name/feature/path. All type objects will be annotated with a IndexTermAnnotation. The value of the IndexTerm is specified by the feature path.

See Also:

Constant Field Values

paths

protected Set<String> paths

PARAM_FILTER_FEATUREPATH

public static final String PARAM_FILTER_FEATUREPATH

Specifies a feature path that is used in the filter. If this is set, you also have to specify PARAM_FILTER_CONDITION_OPERATOR and PARAM_FILTER_CONDITION_VALUE.

See Also:

Constant Field Values

filterFeaturePath

protected String filterFeaturePath

PARAM_FILTER_CONDITION_OPERATOR

public static final String PARAM_FILTER_CONDITION_OPERATOR

Specifies the operator for a filtering condition.

It is only used if PARAM_FILTER_FEATUREPATH is set.

See Also:

FilterOp, Constant Field Values

filterConditionOperator

protected String filterConditionOperator

PARAM_FILTER_CONDITION_VALUE

public static final String PARAM_FILTER_CONDITION_VALUE

Specifies the value for a filtering condition.

It is only used if PARAM_FILTER_FEATUREPATH is set.

See Also:

Condition, Constant Field Values

filterConditionValue

protected String filterConditionValue

filterCondition

protected Condition filterCondition

filterFeaturePathInfo

protected FeaturePathInfo filterFeaturePathInfo

fp

protected FeaturePathInfo fp

Constructor Detail

FeaturePathAnnotatorBase

public FeaturePathAnnotatorBase()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext aContext)
                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

getDefaultPaths

protected Set<String> getDefaultPaths()

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

initializeFeaturePathInfoFrom

public void initializeFeaturePathInfoFrom(FeaturePathInfo aFp,
                                          String[] featurePathString)
                                   throws FeaturePathException

Checks for empty feature path and initializes the feature path object.

Parameters:

aFp - the feature path that is to be initialized with the featurePathString

featurePathString - the string that is used to initialize feature path

Throws:

FeaturePathException - if an error occurs during initialization of the FeaturePathInfo object

generateAnnotations

protected abstract void generateAnnotations(org.apache.uima.jcas.JCas jcas)
                                     throws FeaturePathException,
                                            org.apache.uima.analysis_engine.AnalysisEngineProcessException

Method to create annotations.

Parameters:

jcas - the JCas.

Throws:

FeaturePathException - if an error occurs during initialization of the FeaturePathInfo object

org.apache.uima.analysis_engine.AnalysisEngineProcessException - if another error occurs.