org.apache.uima.annotator.dict_annot.dictionary
Interface DictionaryBuilder

All Known Implementing Classes:

HashMapDictionaryBuilder

public interface DictionaryBuilder

The Dictionary builder interface define the methods to create a new dictionary.

Method Summary

void	addWord(String word) Adds a new word to the dictionary.
Dictionary	getDictionary()
void	setDictionaryProperties(String language, String typeName, boolean caseNormalization, boolean multiWordEntries, String multiWordSeparator) Set the dictionary properties, this method have to be called before words can be added to the dictionary.

Method Detail

getDictionary

Dictionary getDictionary()

Returns:

returns the Dictionary object if the dictionary could be created.

addWord

void addWord(String word)

Adds a new word to the dictionary.

Parameters:

word - word that should be added.

setDictionaryProperties

void setDictionaryProperties(String language,
                             String typeName,
                             boolean caseNormalization,
                             boolean multiWordEntries,
                             String multiWordSeparator)

Set the dictionary properties, this method have to be called before words can be added to the dictionary.

Parameters:

language - dictionary language

typeName - type name for the dictionary content

caseNormalization - case normalization settings

multiWordEntries - multi-word entries setting

multiWordSeparator - multi-word entry separator