uk.ac.open.crc.mdsc.engine

Class DichotomyDiskSpellingDictionary

java.lang.Object

uk.ac.open.crc.mdsc.engine.ASpellSpellingDictionary

uk.ac.open.crc.mdsc.engine.DichotomyDiskSpellingDictionary

All Implemented Interfaces:

SpellingDictionary

Direct Known Subclasses:

CachedDichotomyDiskSpellingDictionary

public class DichotomyDiskSpellingDictionary
extends ASpellSpellingDictionary

Another implementation of SpellDictionary that doesn't cache any words in memory. Avoids the huge footprint of SpellDictionaryHashMap at the cost of relatively minor latency. A future version of this class that implements some caching strategies might be a good idea in the future, if there's any demand for it. This implementation requires a special dictionary file, with "code*word" lines sorted by code. It's using a dichotomy algorithm to search for words in the dictionary

Field Summary

Fields inherited from class uk.ac.open.crc.mdsc.engine.ASpellSpellingDictionary

transformator

Constructor Summary

Constructors

Constructor and Description
DichotomyDiskSpellingDictionary(java.io.File wordListFile) Dictionary convenience Constructor.
DichotomyDiskSpellingDictionary(java.io.File wordListFile, java.io.File phoneticFile) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
DichotomyDiskSpellingDictionary(java.io.File wordListFile, java.io.File phoneticFile, java.lang.String encoding) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
DichotomyDiskSpellingDictionary(java.io.File wordListFile, java.lang.String encoding) Dictionary convenience Constructor.

Method Summary

Modifier and Type	Method and Description
void	addWord(java.lang.String word) Add a word permanently to the dictionary (and the dictionary file).
java.util.List<java.lang.String>	getWords(java.lang.String code) Returns a list of strings (words) for the code.

Methods inherited from class uk.ac.open.crc.mdsc.engine.ASpellSpellingDictionary

getPhoneticCode, getSuggestions, getSuggestions, isCorrect

Methods inherited from class java.lang.Object

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

Constructor Detail

DichotomyDiskSpellingDictionary

public DichotomyDiskSpellingDictionary(java.io.File wordListFile)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Dictionary convenience Constructor.

Parameters:

wordListFile - The file containing the words list for the dictionary

Throws:

java.io.FileNotFoundException - indicates problems locating the words list file on the system

java.io.IOException - indicates problems reading the words list file

DichotomyDiskSpellingDictionary

public DichotomyDiskSpellingDictionary(java.io.File wordListFile,
                                       java.lang.String encoding)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Dictionary convenience Constructor.

Parameters:

wordListFile - The file containing the words list for the dictionary

encoding - Uses the character set encoding specified

Throws:

java.io.FileNotFoundException - indicates problems locating the words list file on the system

java.io.IOException - indicates problems reading the words list file

DichotomyDiskSpellingDictionary

public DichotomyDiskSpellingDictionary(java.io.File wordListFile,
                                       java.io.File phoneticFile)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

Parameters:

wordListFile - The file containing the words list for the dictionary

phoneticFile - The file to use for phonetic transformation of the wordlist.

Throws:

java.io.FileNotFoundException - indicates problems locating the file on the system

java.io.IOException - indicates problems reading the words list file

DichotomyDiskSpellingDictionary

public DichotomyDiskSpellingDictionary(java.io.File wordListFile,
                                       java.io.File phoneticFile,
                                       java.lang.String encoding)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

Parameters:

wordListFile - The file containing the words list for the dictionary

phoneticFile - The file to use for phonetic transformation of the wordlist.

encoding - Uses the character set encoding specified

Throws:

java.io.FileNotFoundException - indicates problems locating the file on the system

java.io.IOException - indicates problems reading the words list file

Method Detail

addWord

public void addWord(java.lang.String word)

Add a word permanently to the dictionary (and the dictionary file). not implemented !

Parameters:

word - The word to add.

getWords

public java.util.List<java.lang.String> getWords(java.lang.String code)

Returns a list of strings (words) for the code.

Specified by:

getWords in class ASpellSpellingDictionary

Parameters:

code - The phonetic code common to the list of words

Returns:

A list of words having the same phonetic code