org.apache.ctakes.lvg.ae

Class LvgBaseTokenAnnotator

java.lang.Object

JCasAnnotator_ImplBase

org.apache.ctakes.lvg.ae.LvgBaseTokenAnnotator

public class LvgBaseTokenAnnotator
extends JCasAnnotator_ImplBase

UIMA annotator that uses the UMLS LVG package to find the canonical form of BaseTokens. The package is also used to find one or more lemmas for a given BaseToken along with its associated part of speech.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	LvgBaseTokenAnnotator.LemmaLocalClass Basic class to group a lemma word with its various parts of speech.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	cmdCacheFileLocation
private int	cmdCacheFreqCutoff
private UimaContext	context
private java.util.Set	exclusionSet
private java.lang.String	lemmaCacheFileLocation
private int	lemmaCacheFreqCutoff
private java.util.Map	lemmaCacheMap
private Logger	logger
private LvgCmdApi	lvgCmd
private java.lang.String	LVGCMDAPI_RESRC_KEY
private LvgLexItemApi	lvgLexItem
private java.util.Map	normCacheMap
static java.lang.String	PARAM_LEMMA_CACHE_FILE_LOCATION Value is "LemmaCacheFileLocation".
static java.lang.String	PARAM_LEMMA_CACHE_FREQUENCY_CUTOFF Value is "LemmaCacheFrequencyCutoff".
static java.lang.String	PARAM_POST_LEMMAS Value is "PostLemmas".
static java.lang.String	PARAM_USE_LEMMA_CACHE Value is "UseLemmaCache".
private boolean	postLemmas
private java.util.Set	skipSegmentsSet
private boolean	useCmdCache
private boolean	useLemmaCache
private boolean	useSegments
private java.util.Map	xeroxTreebankMap

Constructor Summary

Constructors

Constructor and Description
LvgBaseTokenAnnotator()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	annotateRange(JCas jcas, java.lang.String text, int rangeBegin, int rangeEnd) A utility method that annotates a given range.
private void	configInit() Sets configuration parameters with values from the descriptor.
void	initialize(UimaContext aContext) Performs initialization logic.
private void	loadCmdCacheFile(java.lang.String cpLocation) Helper method that loads a Norm cache file.
private void	loadLemmaCacheFile(java.lang.String cpLocation) Helper method that loads a Lemma cache file.
void	process(JCas jcas) Invokes this annotator's analysis logic.
private void	setLemma(BaseToken wordAnnotation, java.lang.String word, JCas jcas)
private void	setNormalizedForm(BaseToken tokenAnnotation, java.lang.String token)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_POST_LEMMAS

public static final java.lang.String PARAM_POST_LEMMAS

Value is "PostLemmas". This parameter determines whether the feature lemmaEntries will be populated for word annotations.

See Also:

Constant Field Values

PARAM_USE_LEMMA_CACHE

public static final java.lang.String PARAM_USE_LEMMA_CACHE

Value is "UseLemmaCache". This parameter determines whether a cache will be used to improve performance of setting lemma entries.

See Also:

Constant Field Values

PARAM_LEMMA_CACHE_FILE_LOCATION

public static final java.lang.String PARAM_LEMMA_CACHE_FILE_LOCATION

Value is "LemmaCacheFileLocation". This parameter determines where the lemma cache is located.

See Also:

Constant Field Values

PARAM_LEMMA_CACHE_FREQUENCY_CUTOFF

public static final java.lang.String PARAM_LEMMA_CACHE_FREQUENCY_CUTOFF

Value is "LemmaCacheFrequencyCutoff". This parameter sets a threshold for the frequency of a lemma to be loaded into the cache.

See Also:

Constant Field Values

logger

private Logger logger

LVGCMDAPI_RESRC_KEY

private final java.lang.String LVGCMDAPI_RESRC_KEY

See Also:

Constant Field Values

lvgCmd

private LvgCmdApi lvgCmd

lvgLexItem

private LvgLexItemApi lvgLexItem

context

private UimaContext context

useSegments

private boolean useSegments

skipSegmentsSet

private java.util.Set skipSegmentsSet

useCmdCache

private boolean useCmdCache

cmdCacheFileLocation

private java.lang.String cmdCacheFileLocation

cmdCacheFreqCutoff

private int cmdCacheFreqCutoff

xeroxTreebankMap

private java.util.Map xeroxTreebankMap

postLemmas

private boolean postLemmas

useLemmaCache

private boolean useLemmaCache

lemmaCacheFileLocation

private java.lang.String lemmaCacheFileLocation

lemmaCacheFreqCutoff

private int lemmaCacheFreqCutoff

normCacheMap

private java.util.Map normCacheMap

lemmaCacheMap

private java.util.Map lemmaCacheMap

exclusionSet

private java.util.Set exclusionSet

Constructor Detail

LvgBaseTokenAnnotator

public LvgBaseTokenAnnotator()

Method Detail

initialize

public void initialize(UimaContext aContext)
                throws ResourceInitializationException

Performs initialization logic. This implementation just reads values for the configuration parameters.

Throws:

ResourceInitializationException

See Also:

org.apache.uima.analysis_engine.annotator.BaseAnnotator#initialize(AnnotatorContext)

configInit

private void configInit()
                 throws ResourceInitializationException

Sets configuration parameters with values from the descriptor.

Throws:

ResourceInitializationException

process

public void process(JCas jcas)
             throws AnalysisEngineProcessException

Invokes this annotator's analysis logic.

Throws:

AnalysisEngineProcessException

annotateRange

protected void annotateRange(JCas jcas,
                 java.lang.String text,
                 int rangeBegin,
                 int rangeEnd)
                      throws AnalysisEngineProcessException

A utility method that annotates a given range.

Throws:

AnalysisEngineProcessException

setNormalizedForm

private void setNormalizedForm(BaseToken tokenAnnotation,
                     java.lang.String token)
                        throws AnalysisEngineProcessException

Throws:

AnalysisEngineProcessException

setLemma

private void setLemma(BaseToken wordAnnotation,
            java.lang.String word,
            JCas jcas)
               throws AnalysisEngineProcessException

Throws:

AnalysisEngineProcessException

loadCmdCacheFile

private void loadCmdCacheFile(java.lang.String cpLocation)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Helper method that loads a Norm cache file.

Parameters:

location -

Throws:

java.io.FileNotFoundException

java.io.IOException

loadLemmaCacheFile

private void loadLemmaCacheFile(java.lang.String cpLocation)
                         throws java.io.FileNotFoundException,
                                java.io.IOException

Helper method that loads a Lemma cache file.

Parameters:

location -

Throws:

java.io.FileNotFoundException

java.io.IOException