Package org.dts.spell.dictionary

Interface SpellDictionary

All Known Implementing Classes:

OpenOfficeSpellDictionary

public interface SpellDictionary

An interface for all dictionary implementations. It defines the most basic operations on a dictionary: adding words, checking if a word is correct, and getting a list of suggestions for misspelled words.

Method Summary

Modifier and Type	Method	Description
void	addWord(java.lang.String word)	Add a word permanently to the dictionary.
java.util.List<java.lang.String>	getSuggestions(java.lang.String word)	Returns a list of String that are the suggestions to any word.
boolean	isCorrect(java.lang.String word)	Returns true if the word is correctly spelled against the dictionary.

Method Detail

addWord

void addWord(java.lang.String word)
      throws SpellDictionaryException

Add a word permanently to the dictionary. In general, to the personal dictionary associated with this main dictionary.

Parameters:

word - a word to add.

Throws:

SpellDictionaryException

isCorrect

boolean isCorrect(java.lang.String word)

Returns true if the word is correctly spelled against the dictionary.

Parameters:

word - a word to check.

getSuggestions

java.util.List<java.lang.String> getSuggestions(java.lang.String word)

Returns a list of String that are the suggestions to any word. If the word is correctly spelled, then this method could return just that one word, or it could still return a list of words with similar spellings.

Parameters:

word - the word that we want to get a list of spelling suggestions for.

Returns:

List a List of suggested words.