Package com.swabunga.spell.engine
Class Word
- java.lang.Object
-
- com.swabunga.spell.engine.Word
-
- All Implemented Interfaces:
java.util.Comparator
public class Word extends java.lang.Object implements java.util.Comparator
The Word object holds information for one suggested spelling. It contains both the suggested word string and the distance cost, which represents how different the suggested word is from the misspelling.This class is now immutable.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compare(java.lang.Object o1, java.lang.Object o2)
Compares two words, mostly for the purpose of sorting words.boolean
equals(java.lang.Object o)
Indicates if this word is equal to another one.int
getCost()
A cost measures how close a match this word was to the original wordjava.lang.String
getWord()
gets suggested spellingvoid
setWord(java.lang.String word)
sets suggested spellingjava.lang.String
toString()
returns the suggested spelling
-
-
-
Method Detail
-
compare
public int compare(java.lang.Object o1, java.lang.Object o2)
Compares two words, mostly for the purpose of sorting words.- Specified by:
compare
in interfacejava.util.Comparator
- Parameters:
o1
- the first wordo2
- the second word- Returns:
- -1 if the first word is more similar to the misspelled word
1 if the second word is more similar to the misspelled word
0 if both words are equally similar
-
equals
public boolean equals(java.lang.Object o)
Indicates if this word is equal to another one.- Specified by:
equals
in interfacejava.util.Comparator
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- The other word to compare- Returns:
- The indication of equality
-
getWord
public java.lang.String getWord()
gets suggested spelling- Returns:
- the actual text of the suggest spelling
-
setWord
public void setWord(java.lang.String word)
sets suggested spelling- Parameters:
word
- The text to set for suggestd spelling
-
getCost
public int getCost()
A cost measures how close a match this word was to the original word- Returns:
- 0 if an exact match. Higher numbers are worse matches.
- See Also:
EditDistance
-
toString
public java.lang.String toString()
returns the suggested spelling- Overrides:
toString
in classjava.lang.Object
- Returns:
- The word's text
-
-