org.apache.ctakes.dictionary.lookup2.ae

Interface JCasTermAnnotator

All Superinterfaces:

org.apache.uima.analysis_component.AnalysisComponent

All Known Implementing Classes:

AbstractJCasTermAnnotator, DefaultJCasTermAnnotator, OverlapJCasTermAnnotator

public interface JCasTermAnnotator
extends org.apache.uima.analysis_component.AnalysisComponent

An annotator that looks up dictionary terms in text using RareWordDictionary s and adds them as entities to the Cas using a TermConsumer Author: SPF Affiliation: CHIP-NLP Date: 2/24/14

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DICT_DESC_PATH
static String	DEFAULT_EXCLUSION_TAGS
static String	DEFAULT_LOOKUP_WINDOW
static int	DEFAULT_MINIMUM_SPAN
static String	DICTIONARY_DESCRIPTOR_KEY Deprecated. replaced by ConfigParameterConstants.PARAM_LOOKUP_XML
static String	PARAM_EXC_TAGS_KEY optional part of speech tags for tokens that should not be used for lookup
static String	PARAM_MIN_SPAN_KEY optional minimum span for tokens that should not be used for lookup
static String	PARAM_WINDOW_ANNOT_KEY specifies the type of window to use for lookup

Method Summary

Modifier and Type	Method and Description
void	findTerms(RareWordDictionary dictionary, List<FastLookupToken> allTokens, List<Integer> lookupTokenIndices, CollectionMap<TextSpan,Long,? extends Collection<Long>> termsFromDictionary) Given a dictionary, tokens, and lookup token indices, populate a terms collection with discovered terms
Collection<RareWordDictionary>	getDictionaries()

Methods inherited from interface org.apache.uima.analysis_component.AnalysisComponent

batchProcessComplete, collectionProcessComplete, destroy, getCasInstancesRequired, getRequiredCasInterface, hasNext, initialize, next, process, reconfigure, setResultSpecification

Field Detail

DICTIONARY_DESCRIPTOR_KEY

@Deprecated
static final String DICTIONARY_DESCRIPTOR_KEY

Deprecated. replaced by ConfigParameterConstants.PARAM_LOOKUP_XML

See Also:

Constant Field Values

PARAM_WINDOW_ANNOT_KEY

static final String PARAM_WINDOW_ANNOT_KEY

specifies the type of window to use for lookup

See Also:

Constant Field Values

PARAM_EXC_TAGS_KEY

static final String PARAM_EXC_TAGS_KEY

optional part of speech tags for tokens that should not be used for lookup

See Also:

Constant Field Values

PARAM_MIN_SPAN_KEY

static final String PARAM_MIN_SPAN_KEY

optional minimum span for tokens that should not be used for lookup

See Also:

Constant Field Values

DEFAULT_LOOKUP_WINDOW

static final String DEFAULT_LOOKUP_WINDOW

See Also:

Constant Field Values

DEFAULT_EXCLUSION_TAGS

static final String DEFAULT_EXCLUSION_TAGS

See Also:

Constant Field Values

DEFAULT_MINIMUM_SPAN

static final int DEFAULT_MINIMUM_SPAN

See Also:

Constant Field Values

DEFAULT_DICT_DESC_PATH

static final String DEFAULT_DICT_DESC_PATH

See Also:

Constant Field Values

Method Detail

getDictionaries

Collection<RareWordDictionary> getDictionaries()

Returns:

Dictionaries that are used by this WindowProcessor

findTerms

void findTerms(RareWordDictionary dictionary,
               List<FastLookupToken> allTokens,
               List<Integer> lookupTokenIndices,
               CollectionMap<TextSpan,Long,? extends Collection<Long>> termsFromDictionary)

Given a dictionary, tokens, and lookup token indices, populate a terms collection with discovered terms

Parameters:

dictionary - -

allTokens - -

lookupTokenIndices - -

termsFromDictionary - -