uk.ac.open.crc.mdsc.engine

Class HashedSpellingDictionary

java.lang.Object

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

uk.ac.open.crc.mdsc.engine.HashedSpellingDictionary

All Implemented Interfaces:

SpellingDictionary

public class HashedSpellingDictionary
extends ASpellSpellingDictionary

The HashedSpellingDictionary holds the dictionary.

This class is thread safe. Derived classes should ensure that this preserved.

There are many open source dictionary files. For just a few see: http://wordlist.sourceforge.net/

This dictionary class reads words one per line. Make sure that your word list is formatted in this way (most are).

Note that you must create the dictionary with a word list for the added words to persist.

Field Summary

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

transformator

Constructor Summary

Constructors

Constructor and Description
HashedSpellingDictionary() Dictionary Constructor.
HashedSpellingDictionary(java.io.File wordListFile) Dictionary convenience Constructor.
HashedSpellingDictionary(java.io.File wordListFile, boolean isNormalised) Dictionary convenience Constructor with the option to normalise the entries.
HashedSpellingDictionary(java.io.File wordListFile, java.io.File phonetic) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
HashedSpellingDictionary(java.io.File wordListFile, java.io.File phonetic, java.lang.String phoneticEncoding) Dictionary constructor that uses an aspell phonetic file to build the transformation table.
HashedSpellingDictionary(java.io.Reader wordList) Dictionary Constructor.
HashedSpellingDictionary(java.io.Reader wordList, boolean isNormalised) Dictionary Constructor with the option to normalise the entries.
HashedSpellingDictionary(java.io.Reader wordListFile, java.io.Reader phonetic) Dictionary constructor that uses an aspell phonetic file to build the transformation table.

Method Summary

Modifier and Type	Method and Description
void	addDictionary(java.io.File wordListFile) Add words from a file to an existing dictionary HashMap.
void	addDictionary(java.io.Reader wordList) Add words from a Reader to existing dictionary HashMap.
protected void	addDictionaryHelper(java.io.BufferedReader in) Adds to the existing dictionary from a word list file.
void	addWord(java.lang.String word) Add a word permanently to the dictionary (and the dictionary file).
protected void	createDictionary(java.io.BufferedReader in) Constructs the dictionary from a word list file.
protected void	createNormalisedDictionary(java.io.BufferedReader in) Constructs the dictionary from a word list file where all words are normalised to lower case.
java.util.List<java.lang.String>	getWords(java.lang.String code) Returns a list of strings (words) for the phonetic code.
protected void	putWord(java.lang.String word) Stores a word in the dictionary
protected void	putWordUnique(java.lang.String word) Stores a word, if it is not already present in the dictionary.

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

HashedSpellingDictionary

public HashedSpellingDictionary()
                         throws java.io.IOException

Dictionary Constructor.

Throws:

java.io.IOException - indicates a problem with the file system

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.Reader wordList)
                         throws java.io.IOException

Dictionary Constructor.

Parameters:

wordList - The file containing the words list for the dictionary

Throws:

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

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.Reader wordList,
                                boolean isNormalised)
                         throws java.io.IOException

Dictionary Constructor with the option to normalise the entries.

Parameters:

wordList - The file containing the words list for the dictionary

isNormalised - indicates whether the word list should be normalised to lower case

Throws:

java.io.IOException - if problems were encountered reading the word list file

HashedSpellingDictionary

public HashedSpellingDictionary(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 - if a problem was encountered locating the word list file on the system

java.io.IOException - if problems were encountered reading the word list file

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.File wordListFile,
                                boolean isNormalised)
                         throws java.io.FileNotFoundException,
                                java.io.IOException

Dictionary convenience Constructor with the option to normalise the entries.

Parameters:

wordListFile - The file containing the words list for the dictionary

isNormalised - indicates whether the word list should be normalised to lower case

Throws:

java.io.FileNotFoundException - if a problem was encountered locating the word list file on the system

java.io.IOException - if problems were encountered reading the word list file

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.File wordListFile,
                                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:

wordListFile - The file containing the words list for the dictionary

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

Throws:

java.io.FileNotFoundException - if a problem was encountered locating the word list file on the system

java.io.IOException - if problems were encountered reading the word list file

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.File wordListFile,
                                java.io.File phonetic,
                                java.lang.String phoneticEncoding)
                         throws java.io.FileNotFoundException,
                                java.io.IOException

Dictionary constructor that uses an aspell phonetic file to build the transformation table. Encoding is used for phonetic file only; default encoding is used for wordList

Parameters:

wordListFile - The file containing the words list for the dictionary

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

phoneticEncoding - Uses the character set encoding specified

Throws:

java.io.FileNotFoundException - if a problem was encountered locating the word list file on the system

java.io.IOException - if problems were encountered reading the word list file

HashedSpellingDictionary

public HashedSpellingDictionary(java.io.Reader wordListFile,
                                java.io.Reader phonetic)
                         throws 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

phonetic - The reader to use for phonetic transformation of the wordlist.

Throws:

java.io.IOException - if problems were encountered reading the word list or phonetic information

Method Detail

addDictionary

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

Add words from a file to an existing dictionary HashMap. This method can be called as many times as needed to build the internal word list. Duplicates are not added.

Note that adding a dictionary does not affect the target dictionary file for the addWord method. That is, addWord() continues to make additions to the dictionary file specified in createDictionary()

Parameters:

wordListFile - a File object that contains the words, one word per line.

Throws:

java.io.FileNotFoundException - if the file is not located

java.io.IOException - if a problem is encountered reading the file

addDictionary

public void addDictionary(java.io.Reader wordList)
                   throws java.io.IOException

Add words from a Reader to existing dictionary HashMap. This method can be called as many times as needed to build the internal word list. Duplicates are not added.

Note that adding a dictionary does not affect the target dictionary file for the addWord method. That is, addWord() continues to make additions to the dictionary file specified in createDictionary()

Parameters:

wordList - a Reader object that contains the words, one word per line.

Throws:

java.io.IOException - if a problem is encountered adding words to the dictionary.

addWord

public void addWord(java.lang.String word)

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

This needs to be made thread safe

Not implemented!

Parameters:

word - A word to add to the dictionary.

createDictionary

protected final void createDictionary(java.io.BufferedReader in)
                               throws java.io.IOException

Constructs the dictionary from a word list file.

Each word in the reader should be on a separate line.

Parameters:

in - a reader for a word list file

Throws:

java.io.IOException - if a problem is encountered reading the file.

createNormalisedDictionary

protected final void createNormalisedDictionary(java.io.BufferedReader in)
                                         throws java.io.IOException

Constructs the dictionary from a word list file where all words are normalised to lower case.

Each word in the reader should be on a separate line.

This is a very slow function. On my machine it takes quite a while to load the data in. I suspect that we could speed this up quite a lot.

Parameters:

in - a reader for a word list file

Throws:

java.io.IOException - if a problem is encountered reading the file.

addDictionaryHelper

protected void addDictionaryHelper(java.io.BufferedReader in)
                            throws java.io.IOException

Adds to the existing dictionary from a word list file. If the word already exists in the dictionary, a new entry is not added.

Each word in the reader should be on a separate line.

Parameters:

in - a reader for a word list file

Throws:

java.io.IOException - if a problem is encountered reading the file.

putWord

protected void putWord(java.lang.String word)

Stores a word in the dictionary

Parameters:

word - The word to add

putWordUnique

protected void putWordUnique(java.lang.String word)

Stores a word, if it is not already present in the dictionary. A word with a different case is considered the same.

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 phonetic code.

Specified by:

getWords in class ASpellSpellingDictionary

Parameters:

code - a phonetic code.

Returns:

a list of words associated with the phonetic code.