uk.ac.open.crc.mdsc.engine

Class ASpellSpellingDictionary

java.lang.Object

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

All Implemented Interfaces:

SpellingDictionary

Direct Known Subclasses:

DichotomyDiskSpellingDictionary, DiskSpellingDictionary, GenericSpellingDictionary, HashedSpellingDictionary

public abstract class ASpellSpellingDictionary
extends java.lang.Object
implements SpellingDictionary

Container for various methods that any SpellingDictionary will use. This class is based on the original Jazzy aspell port.

Derived classes will need words list files as spell checking reference. Words list file is a dictionary with one word per line. There are many open source dictionary files, see: http://wordlist.sourceforge.net/

You can choose words lists from aspell's many different language dictionaries. To grab some, install aspell and the dictionaries you require. Then run aspell specifying the name of the dictionary and the words list file to dump it into, for example:
aspell --master=fr-40 dump master > fr-40.txt
Note: the number following the language is the size indicator. A bigger number gives a more extensive language coverage. Size 40 is more than adequate for many usages.

For some languages, Aspell can also supply you with the phonetic file. On Windows, go into aspell data directory and copy the phonetic file corresponding to your language, for example the fr_phonet.dat for the fr language. The phonetic file should be in directory /usr/share/aspell on Unix.

See Also:

GenericTransformator for information on phonetic files.

Field Summary

Fields

Modifier and Type	Field and Description
protected Transformator	transformator The reference to a Transformator, used to transform a word into its phonetic code.

Constructor Summary

Constructors

Constructor and Description
ASpellSpellingDictionary(java.io.File phonetic) Constructs a new SpellDictionaryASpell
ASpellSpellingDictionary(java.io.File phonetic, java.lang.String encoding) Constructs a new SpellDictionaryASpell
ASpellSpellingDictionary(java.io.Reader phonetic) Constructs a new ASpellSpellingDictionary

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPhoneticCode(java.lang.String word) Returns the phonetic code representing the word.
java.util.List<Word>	getSuggestions(java.lang.String word, int threshold) Returns a list of Word objects that are the suggestions to an incorrect word.
java.util.List<Word>	getSuggestions(java.lang.String word, int threshold, int[][] matrix) Returns a list of Word objects that are the suggestions to an incorrect word.
protected abstract java.util.List<java.lang.String>	getWords(java.lang.String phoneticCode) Returns a list of words that have the same phonetic code.
boolean	isCorrect(java.lang.String word) Returns true if the word is correctly spelled against the current word list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.open.crc.mdsc.engine.SpellingDictionary

addWord

Field Detail

transformator

protected Transformator transformator

The reference to a Transformator, used to transform a word into its phonetic code.

Constructor Detail

ASpellSpellingDictionary

public ASpellSpellingDictionary(java.io.File phonetic)
                         throws java.io.IOException

Constructs a new SpellDictionaryASpell

Parameters:

phonetic - The file to use for phonetic transformation of the words list. If phonetic is null, the the transformation uses DoubleMetaphoneTransformator transformation.

Throws:

java.io.IOException - indicates problems reading the phonetic information

ASpellSpellingDictionary

public ASpellSpellingDictionary(java.io.File phonetic,
                                java.lang.String encoding)
                         throws java.io.IOException

Constructs a new SpellDictionaryASpell

Parameters:

phonetic - The file to use for phonetic transformation of the words list. If phonetic is null, the the transformation uses DoubleMetaphoneTransformator transformation.

encoding - Uses the character set encoding specified

Throws:

java.io.IOException - indicates problems reading the phonetic information

ASpellSpellingDictionary

public ASpellSpellingDictionary(java.io.Reader phonetic)
                         throws java.io.IOException

Constructs a new ASpellSpellingDictionary

Parameters:

phonetic - The Reader to use for phonetic transformation of the words list. If phonetic is null, the the transformation uses DoubleMetaphoneTransformator transformation.

Throws:

java.io.IOException - indicates problems reading the phonetic information

Method Detail

getSuggestions

public java.util.List<Word> getSuggestions(java.lang.String word,
                                           int threshold)

Returns a list of Word objects that are the suggestions to an incorrect word.

This method is only needed to provide backward compatibility.

Specified by:

getSuggestions in interface SpellingDictionary

Parameters:

word - Suggestions for given misspelt word

threshold - The lower boundary of similarity to misspelt word

Returns:

a List of suggested alternative spellings

See Also:

getSuggestions(String, int, int[][])

getSuggestions

public java.util.List<Word> getSuggestions(java.lang.String word,
                                           int threshold,
                                           int[][] matrix)

Returns a list of Word objects that are the suggestions to an incorrect word.

Specified by:

getSuggestions in interface SpellingDictionary

Parameters:

word - suggestions for given misspelt word

threshold - The lower boundary of similarity to misspelt word

matrix - Two dimensional int array used to calculate edit distance. Allocating this memory outside of the function will greatly improve efficiency.

Returns:

Vector a List of suggested alternative spellings

See Also:

Word

getPhoneticCode

public java.lang.String getPhoneticCode(java.lang.String word)

Returns the phonetic code representing the word.

Parameters:

word - The word we want the phonetic code.

Returns:

The value of the phonetic code for the word.

getWords

protected abstract java.util.List<java.lang.String> getWords(java.lang.String phoneticCode)

Returns a list of words that have the same phonetic code.

Parameters:

phoneticCode - The phonetic code common to the list of words

Returns:

A list of words having the same phonetic code

isCorrect

public boolean isCorrect(java.lang.String word)

Returns true if the word is correctly spelled against the current word list.

Specified by:

isCorrect in interface SpellingDictionary

Parameters:

word - The word to verify if its spelling is OK.

Returns:

Indicates if the word is present in the dictionary.