org.apache.ctakes.dictionary.lookup

Interface Dictionary

All Known Implementing Classes:

AbstractBaseDictionary, BaseDictionaryImpl, JdbcDictionaryImpl, LuceneDictionaryImpl, StringTableDictionaryImpl

public interface Dictionary

Author:

Mayo Clinic

Method Summary

Modifier and Type	Method and Description
boolean	contains(String text) Determines whether the Dictionary contains the specified input text.
Collection<MetaDataHit>	getEntries(String text) Gets any meta data entries associated with the specified input text.
void	retainMetaData(String metaFieldName) Tells the Dictionary to retain specific bits of metadata for each entry in the Dictionary.

Method Detail

retainMetaData

void retainMetaData(String metaFieldName)

Tells the Dictionary to retain specific bits of metadata for each entry in the Dictionary.

Parameters:

metaFieldName - Name specific to Dictionary implementation.

contains

boolean contains(String text)
          throws DictionaryException

Determines whether the Dictionary contains the specified input text.

Parameters:

text - The input text.

Returns:

true if Dictionary contains input text, false otherwise.

Throws:

DictionaryException

getEntries

Collection<MetaDataHit> getEntries(String text)
                            throws DictionaryException

Gets any meta data entries associated with the specified input text.

Parameters:

text - The input text.

Returns:

Collection of MetaDataHit objects.

Throws:

DictionaryException