uk.ac.open.crc.mdsc

Class DictionaryManager

java.lang.Object

uk.ac.open.crc.mdsc.DictionaryManager

Direct Known Subclasses:

AbbreviationDictionaryManager, AcronymDictionaryManager, DefaultDictionaryManager, NormalisedAbbreviationDictionaryManager, NormalisedDictionaryManager, NormalisedIso3166DictionaryManager

public class DictionaryManager
extends java.lang.Object

A class used to populate and configure a group of dictionaries. Spell checking is accomplished by using an instance of the DictionarySet class obtained from the dictionarySet() method.

The subclasses of DictionaryManager are all convenience classes with particular word lists loaded.

Constructor Summary

Constructors

Constructor and Description
DictionaryManager() Creates a DictionaryManager with an empty set of dictionaries.

Method Summary

Modifier and Type	Method and Description
Dictionary	create(java.lang.String name, java.lang.String description, java.io.File wordListFile) Creates a Dictionary using the supplied word list.
Dictionary	create(java.lang.String name, java.lang.String description, java.io.File wordListFile, boolean isNormalised) Creates a Dictionary using the supplied word list.
Dictionary	create(java.lang.String name, java.lang.String description, java.io.Reader wordListReader, boolean isNormalised) Creates a Dictionary using the supplied word list which can be in a jar file, on the file system or ….
DictionarySet	dictionarySet() Retrieves the current dictionary set.
void	reset() Resets the dictionary manager to its default settings and creates a new default (empty) dictionary set.
void	setCostThreshold(int maximumCost) Sets the maximum cost of any suggested spellings returned by a dictionary.
void	setMaximumSuggestions(int maximumSuggestions) Sets the maximum number of suggested spellings returned by a dictionary.

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryManager

public DictionaryManager()

Creates a DictionaryManager with an empty set of dictionaries. Add dictionaries using the create methods.

Method Detail

create

public final Dictionary create(java.lang.String name,
                               java.lang.String description,
                               java.io.File wordListFile)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Creates a Dictionary using the supplied word list. The dictionary is registered with the current DictionarySet. To use an individual dictionary use the reference returned by this method. To use a group of dictionaries create them using this method then recover the DictionarySet using dictionarySet()

Parameters:

name - an unique name for the dictionary.

description - a brief description of the dictionary

wordListFile - a file containing a word list

Returns:

an instance of Dictionary

Throws:

java.io.FileNotFoundException - if the word list file cannot be found

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

create

public final Dictionary create(java.lang.String name,
                               java.lang.String description,
                               java.io.File wordListFile,
                               boolean isNormalised)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Creates a Dictionary using the supplied word list. The dictionary is registered with the current DictionarySet. To use an individual dictionary use the reference returned by this method. To use a group of dictionaries create them using this method then recover the DictionarySet using dictionarySet()

Parameters:

name - an unique name for the dictionary.

description - a brief description of the dictionary

wordListFile - a file containing a word list

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

Returns:

an instance of Dictionary

Throws:

java.io.FileNotFoundException - if the word list file cannot be found

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

create

public final Dictionary create(java.lang.String name,
                               java.lang.String description,
                               java.io.Reader wordListReader,
                               boolean isNormalised)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Creates a Dictionary using the supplied word list which can be in a jar file, on the file system or …. The dictionary is registered with the current DictionarySet. To use an individual dictionary use the reference returned by this method. To use a group of dictionaries create them using this method then recover the DictionarySet using dictionarySet()

Parameters:

name - an unique name for the dictionary.

description - a brief description of the dictionary

wordListReader - a Reader pointing to a word list

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

Returns:

an instance of Dictionary

Throws:

java.io.FileNotFoundException - if the word list file cannot be found

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

setCostThreshold

public void setCostThreshold(int maximumCost)

Sets the maximum cost of any suggested spellings returned by a dictionary. Transformations have the following costs: deletion 95, swap 90, substitution 100, and a change of case 10. The default maximum cost is 200.

Parameters:

maximumCost - the maximum cost of a transformation to an alternative spelling.

setMaximumSuggestions

public void setMaximumSuggestions(int maximumSuggestions)

Sets the maximum number of suggested spellings returned by a dictionary.

The new threshold only applies to dictionaries created by the manager after it has been set.

Parameters:

maximumSuggestions - the maximum number of suggested alternative spellings to be returned by a dictionary.

dictionarySet

public DictionarySet dictionarySet()

Retrieves the current dictionary set.

A copy of the current set of dictionaries and the state of the configuration variables is returned. Further changes to the configuration and number of dictionaries made through the manager object should not affect the copy.

Returns:

A dictionary set

reset

public void reset()

Resets the dictionary manager to its default settings and creates a new default (empty) dictionary set.