org.apache.ctakes.lvg.ae

Class LvgAnnotator

java.lang.Object

JCasAnnotator_ImplBase

org.apache.ctakes.lvg.ae.LvgAnnotator

public class LvgAnnotator
extends JCasAnnotator_ImplBase

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	LvgAnnotator.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
static java.lang.String[]	defaultExclusionWords
static java.lang.String[]	defaultTreebankMap
private java.util.Set<java.lang.String>	exclusionSet
private java.lang.String	lemmaCacheFileLocation
private int	lemmaCacheFreqCutoff
private java.util.Map<java.lang.String,java.util.Set<LvgAnnotator.LemmaLocalClass>>	lemmaCacheMap
private Logger	logger
private LvgCmdApi	lvgCmd
private LvgLexItemApi	lvgLexItem
private LvgCmdApiResource	lvgResource
private java.util.Map<java.lang.String,java.lang.String>	normCacheMap
static java.lang.String	PARAM_CMD_CACHE_FILE
static java.lang.String	PARAM_EXCLUSION_WORDS
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_LEMMA_FREQ_CUTOFF
static java.lang.String	PARAM_LVGCMDAPI_RESRC_KEY
static java.lang.String	PARAM_POST_LEMMAS Value is "PostLemmas".
static java.lang.String	PARAM_SKIP_SEGMENTS
static java.lang.String	PARAM_USE_CMD_CACHE
static java.lang.String	PARAM_USE_LEMMA_CACHE Value is "UseLemmaCache".
static java.lang.String	PARAM_USE_SEGMENTS
static java.lang.String	PARAM_XT_MAP
private boolean	postLemmas
private java.lang.String[]	skipSegmentIDs
private java.util.Set<java.lang.String>	skipSegmentsSet
private boolean	useCmdCache
private boolean	useLemmaCache
private boolean	useSegments
private java.lang.String[]	wordsToExclude
private java.util.Map<java.lang.String,java.lang.String>	xeroxTreebankMap
private java.lang.String[]	xtMaps

Constructor Summary

Constructors

Constructor and Description
LvgAnnotator()

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.
static AnalysisEngineDescription	createAnnotatorDescription()
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	setCanonicalForm(WordToken wordAnnotation, java.lang.String word)
private void	setLemma(WordToken wordAnnotation, java.lang.String word, JCas jcas)

Methods inherited from class java.lang.Object

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

Field Detail

defaultExclusionWords

public static final java.lang.String[] defaultExclusionWords

defaultTreebankMap

public static final java.lang.String[] defaultTreebankMap

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

postLemmas

private boolean postLemmas

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

useLemmaCache

private boolean useLemmaCache

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

lemmaCacheFileLocation

private java.lang.String lemmaCacheFileLocation

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

cmdCacheFreqCutoff

private int cmdCacheFreqCutoff

PARAM_USE_SEGMENTS

public static final java.lang.String PARAM_USE_SEGMENTS

See Also:

Constant Field Values

useSegments

private boolean useSegments

PARAM_SKIP_SEGMENTS

public static final java.lang.String PARAM_SKIP_SEGMENTS

See Also:

Constant Field Values

skipSegmentIDs

private java.lang.String[] skipSegmentIDs

skipSegmentsSet

private java.util.Set<java.lang.String> skipSegmentsSet

PARAM_XT_MAP

public static final java.lang.String PARAM_XT_MAP

See Also:

Constant Field Values

xtMaps

private java.lang.String[] xtMaps

xeroxTreebankMap

private java.util.Map<java.lang.String,java.lang.String> xeroxTreebankMap

PARAM_USE_CMD_CACHE

public static final java.lang.String PARAM_USE_CMD_CACHE

See Also:

Constant Field Values

useCmdCache

private boolean useCmdCache

PARAM_CMD_CACHE_FILE

public static final java.lang.String PARAM_CMD_CACHE_FILE

See Also:

Constant Field Values

cmdCacheFileLocation

private java.lang.String cmdCacheFileLocation

PARAM_LEMMA_FREQ_CUTOFF

public static final java.lang.String PARAM_LEMMA_FREQ_CUTOFF

See Also:

Constant Field Values

lemmaCacheFreqCutoff

private int lemmaCacheFreqCutoff

PARAM_EXCLUSION_WORDS

public static final java.lang.String PARAM_EXCLUSION_WORDS

See Also:

Constant Field Values

wordsToExclude

private java.lang.String[] wordsToExclude

exclusionSet

private java.util.Set<java.lang.String> exclusionSet

logger

private Logger logger

PARAM_LVGCMDAPI_RESRC_KEY

public static final java.lang.String PARAM_LVGCMDAPI_RESRC_KEY

See Also:

Constant Field Values

lvgResource

private LvgCmdApiResource lvgResource

lvgCmd

private LvgCmdApi lvgCmd

lvgLexItem

private LvgLexItemApi lvgLexItem

normCacheMap

private java.util.Map<java.lang.String,java.lang.String> normCacheMap

lemmaCacheMap

private java.util.Map<java.lang.String,java.util.Set<LvgAnnotator.LemmaLocalClass>> lemmaCacheMap

Constructor Detail

LvgAnnotator

public LvgAnnotator()

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()

Sets configuration parameters with values from the descriptor.

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

setCanonicalForm

private void setCanonicalForm(WordToken wordAnnotation,
                    java.lang.String word)
                       throws AnalysisEngineProcessException

Throws:

AnalysisEngineProcessException

setLemma

private void setLemma(WordToken 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

createAnnotatorDescription

public static AnalysisEngineDescription createAnnotatorDescription()
                                                            throws ResourceInitializationException

Throws:

ResourceInitializationException