DictionaryAnnotator (DKPro Core - Master Aggregator 1.7.0 API)

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.dictionaryannotator.DictionaryAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class DictionaryAnnotator
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase
```
Takes a plain text file with phrases as input and annotates the phrases in the CAS file. The annotation type defaults to NGram, but can be changed. The component requires that Tokens and Sentencees are annotated in the CAS. The format of the phrase file is one phrase per line, tokens are separated by space:
```
 this is a phrase
 another phrase
 
```
Author:

Johannes Hoffart, Richard Eckart de Castilho

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_ANNOTATION_TYPE` The annotation to create on matching phases.
`static String`	`PARAM_MODEL_ENCODING` The character encoding used by the model.
`static String`	`PARAM_MODEL_LOCATION` The file must contain one phrase per line - phrases will be split at " "
`static String`	`PARAM_VALUE` The value to set the feature configured in `PARAM_VALUE_FEATURE` to.
`static String`	`PARAM_VALUE_FEATURE` Set this feature on the created annotations.

Constructor Summary

Constructors
Constructor and Description

DictionaryAnnotator()

Constructors
Constructor and Description
`DictionaryAnnotator()`

Method Summary

Methods
Modifier and Type Method and Description

void initialize(org.apache.uima.UimaContext aContext)

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

Methods
Modifier and Type	Method and Description
`void`	`initialize(org.apache.uima.UimaContext aContext)`
`void`	`process(org.apache.uima.jcas.JCas jcas)`

- Field Detail
  - PARAM_MODEL_LOCATION
```
public static final String PARAM_MODEL_LOCATION
```
    The file must contain one phrase per line - phrases will be split at " "
    
    See Also:
    Constant Field Values
  - PARAM_MODEL_ENCODING
```
public static final String PARAM_MODEL_ENCODING
```
    The character encoding used by the model.
    
    See Also:
    Constant Field Values
  - PARAM_ANNOTATION_TYPE
```
public static final String PARAM_ANNOTATION_TYPE
```
    The annotation to create on matching phases. If nothing is specified, this defaults to NGram.
    
    See Also:
    Constant Field Values
  - PARAM_VALUE_FEATURE
```
public static final String PARAM_VALUE_FEATURE
```
    Set this feature on the created annotations.
    
    See Also:
    Constant Field Values
  - PARAM_VALUE
```
public static final String PARAM_VALUE
```
    The value to set the feature configured in PARAM_VALUE_FEATURE to.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DictionaryAnnotator
```
public DictionaryAnnotator()
```
- 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
  - 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

Class DictionaryAnnotator

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

PARAM_MODEL_LOCATION

PARAM_MODEL_ENCODING

PARAM_ANNOTATION_TYPE

PARAM_VALUE_FEATURE

PARAM_VALUE

Constructor Detail

DictionaryAnnotator

Method Detail

initialize

process