uk.ac.open.crc.mdsc.engine

Class Word

java.lang.Object

uk.ac.open.crc.mdsc.engine.Word

All Implemented Interfaces:

java.util.Comparator<Word>

public class Word
extends java.lang.Object
implements java.util.Comparator<Word>

The Word object holds information for one suggested spelling. It contains both the suggested text string and the distance cost, which represents how different the suggested text is from the misspelling.

Constructor Summary

Constructors

Constructor and Description
Word() Constructs a new Word.
Word(java.lang.String text, int score) Constructs a new Word.

Method Summary

Modifier and Type	Method and Description
int	compare(Word word1, Word word2) Compares two words, mostly for the purpose of sorting words.
boolean	equals(java.lang.Object o) Indicates if this text is equal to another one.
int	getCost() A cost measures how close a match this text was to the original text.
java.lang.String	getText() gets suggested spelling
int	hashCode()
void	setText(java.lang.String text) Sets suggested spelling.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

Word

public Word(java.lang.String text,
            int score)

Constructs a new Word.

Parameters:

text - the text of a suggested spelling

score - the cost of transformation between the tested word and text

Word

public Word()

Constructs a new Word.

Method Detail

compare

public int compare(Word word1,
                   Word word2)

Compares two words, mostly for the purpose of sorting words.

Specified by:

compare in interface java.util.Comparator<Word>

Parameters:

word1 - the first text

word2 - the second text

Returns:

-1 if the first text is more similar to the misspelled text
1 if the second text is more similar to the misspelled text
0 if both words are equally similar

equals

public boolean equals(java.lang.Object o)

Indicates if this text is equal to another one.

Specified by:

equals in interface java.util.Comparator<Word>

Overrides:

equals in class java.lang.Object

Parameters:

o - The other text to compare

Returns:

The indication of equality

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getText

public java.lang.String getText()

gets suggested spelling

Returns:

the actual text of the suggest spelling

setText

public void setText(java.lang.String text)

Sets suggested spelling.

Parameters:

text - the text of the suggested spelling

getCost

public int getCost()

A cost measures how close a match this text was to the original text.

Returns:

0 if an exact match. Higher numbers are worse matches.

See Also:

EditDistance