org.apache.ctakes.dictionary.lookup2.dictionary

Class BsvRareWordDictionary

java.lang.Object

org.apache.ctakes.dictionary.lookup2.dictionary.BsvRareWordDictionary

All Implemented Interfaces:

RareWordDictionary

public final class BsvRareWordDictionary
extends Object
implements RareWordDictionary

A RareWordDictionary created from a bar-separated value (BSV) file. The file can have 2 or 3 columns, in the format CUI|TEXT or CUI|TUI|TEXT. The text will be tokenized and rare word indexing done automatically for internal storage and retrieval. If TUI is not supplied then CUI duplicates as TUI. This dictionary is really just a wrapper of a MemRareWordDictionary with a file reader. Author: SPF Affiliation: CHIP-NLP Date: 1/9/14

Constructor Summary

Constructors

Constructor and Description
BsvRareWordDictionary(String name, String bsvFilePath)
BsvRareWordDictionary(String name, org.apache.uima.UimaContext uimaContext, Properties properties)

Method Summary

Modifier and Type	Method and Description
String	getName() The Type identifier and Name are used to maintain a collection of dictionaries, so the combination of Type and Name should be unique for each dictionary if possible.
Collection<RareWordTerm>	getRareWordHits(FastLookupToken fastLookupToken) Any single token can exist in zero or more terms in the dictionary.
Collection<RareWordTerm>	getRareWordHits(String rareWordText) Get all terms within the dictionary that contain a given rare word

Methods inherited from class java.lang.Object

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

Constructor Detail

BsvRareWordDictionary

public BsvRareWordDictionary(String name,
                             org.apache.uima.UimaContext uimaContext,
                             Properties properties)

BsvRareWordDictionary

public BsvRareWordDictionary(String name,
                             String bsvFilePath)

Method Detail

getName

public String getName()

The Type identifier and Name are used to maintain a collection of dictionaries, so the combination of Type and Name should be unique for each dictionary if possible.

Specified by:

getName in interface RareWordDictionary

Returns:

simple name for the dictionary

getRareWordHits

public Collection<RareWordTerm> getRareWordHits(FastLookupToken fastLookupToken)

Any single token can exist in zero or more terms in the dictionary. It may exist as its -own- form or as an alternate canonical variant. This method will check the dictionary for both

Specified by:

getRareWordHits in interface RareWordDictionary

Parameters:

fastLookupToken - a single-word token

Returns:

zero or more terms that contain the lookup token

getRareWordHits

public Collection<RareWordTerm> getRareWordHits(String rareWordText)

Get all terms within the dictionary that contain a given rare word

Specified by:

getRareWordHits in interface RareWordDictionary

Parameters:

rareWordText - text of the rare word

Returns:

all terms within the dictionary that contain rareWordText