uk.ac.open.crc.mdsc

Class SuggestedSpelling

java.lang.Object

uk.ac.open.crc.mdsc.SuggestedSpelling

All Implemented Interfaces:

java.lang.Comparable<SuggestedSpelling>

public final class SuggestedSpelling
extends java.lang.Object
implements java.lang.Comparable<SuggestedSpelling>

A class containing a suggested spelling, the cost of changing the given word to the candidate spelling and the name of the dictionary used to identify the suggestion.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SuggestedSpelling compared)
int	cost() The cost of the transformation(s) required to change the spell checked word to the substitution.
java.lang.String	dictionaryName() Retrieves the name of the dictionary that supplied the suggested spelling.
java.lang.String	word() The word tested.

Methods inherited from class java.lang.Object

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

Method Detail

word

public java.lang.String word()

The word tested.

Returns:

a String containing the word tested by the caller.

cost

public int cost()

The cost of the transformation(s) required to change the spell checked word to the substitution. The individual costs are substitution 100, deletion 95, swap two letters 90, and change case 10.

Returns:

an integer indicating the cost of transforming the input word

dictionaryName

public java.lang.String dictionaryName()

Retrieves the name of the dictionary that supplied the suggested spelling.

Returns:

a dictionary name

compareTo

public int compareTo(SuggestedSpelling compared)

Specified by:

compareTo in interface java.lang.Comparable<SuggestedSpelling>