uk.ac.open.crc.mdsc.engine

Class CachedDichotomyDiskSpellingDictionary

java.lang.Object

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

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

uk.ac.open.crc.mdsc.engine.CachedDichotomyDiskSpellingDictionary

All Implemented Interfaces:

SpellingDictionary

public class CachedDichotomyDiskSpellingDictionary
extends DichotomyDiskSpellingDictionary

Yet another SpellDictionary this one is based on Damien Guillaume's Diskbased dictionary but adds a cache to try to improve a bit on performance.

Field Summary

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

transformator

Constructor Summary

Constructors

Constructor and Description
CachedDichotomyDiskSpellingDictionary(java.io.File wordList) Dictionary Convenience Constructor.
CachedDichotomyDiskSpellingDictionary(java.io.File wordList, java.io.File phonetic) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
CachedDichotomyDiskSpellingDictionary(java.io.File wordList, java.io.File phonetic, java.lang.String encoding) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
CachedDichotomyDiskSpellingDictionary(java.io.File wordList, 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).
void	clearCache() Clears the cache.
java.util.List<java.lang.String>	getWords(java.lang.String code) Returns a list of strings (words) for the code.
void	saveCache()

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

CachedDichotomyDiskSpellingDictionary

public CachedDichotomyDiskSpellingDictionary(java.io.File wordList)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException

Dictionary Convenience Constructor.

Parameters:

wordList - a file containing a list of words one per line.

Throws:

java.io.FileNotFoundException - if file is not accessible

java.io.IOException

CachedDichotomyDiskSpellingDictionary

public CachedDichotomyDiskSpellingDictionary(java.io.File wordList,
                                             java.lang.String encoding)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException

Dictionary Convenience Constructor.

Parameters:

wordList - a file containing a list of words

encoding - the encoding for the file

Throws:

java.io.FileNotFoundException - if the file cannot be located

java.io.IOException

CachedDichotomyDiskSpellingDictionary

public CachedDichotomyDiskSpellingDictionary(java.io.File wordList,
                                             java.io.File phonetic)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException

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

Parameters:

wordList - a file containing a list of words.

phonetic - an aspell phonetic file

Throws:

java.io.FileNotFoundException - if either file cannot be located

java.io.IOException

CachedDichotomyDiskSpellingDictionary

public CachedDichotomyDiskSpellingDictionary(java.io.File wordList,
                                             java.io.File phonetic,
                                             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:

wordList - a file containing a list of words

phonetic - an aspell phonetic file

encoding - the character encoding used in the word list

Throws:

java.io.FileNotFoundException - if either file cannot be located

java.io.IOException - generic file system or read errors.

Method Detail

addWord

public void addWord(java.lang.String word)

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

Specified by:

addWord in interface SpellingDictionary

Overrides:

addWord in class DichotomyDiskSpellingDictionary

Parameters:

word - The word to add.

clearCache

public void clearCache()

Clears the cache.

getWords

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

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

Overrides:

getWords in class DichotomyDiskSpellingDictionary

Parameters:

code - The phonetic code common to the list of words

Returns:

a list of words.

saveCache

public void saveCache()
               throws java.io.IOException

Throws:

java.io.IOException - Saves the current cache to file.