Package com.swabunga.spell.engine

Class Word

java.lang.Object
com.swabunga.spell.engine.Word
All Implemented Interfaces:
Comparator
public class Word extends Object implements 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.

  • Constructor Details

    • Word

      public Word(String word, int score)
      Constructs a new Word.
      Parameters:
      word - The text of a word.
      score - The word's distance cost

    • Word

      public Word()
      Constructs a new Word.

  • Method Details

    • compare

      public int compare(Object o1, Object o2)
      Compares two words, mostly for the purpose of sorting words.
      Specified by:
      compare in interface Comparator
      Parameters:
      o1 - the first word
      o2 - 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(Object o)
      Indicates if this word is equal to another one.
      Specified by:
      equals in interface Comparator
      Overrides:
      equals in class Object
      Parameters:
      o - The other word to compare
      Returns:
      The indication of equality

    • getWord

      public String getWord()
      gets suggested spelling
      Returns:
      the actual text of the suggest spelling

    • setWord

      public void setWord(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:

    • toString

      public String toString()
      returns the suggested spelling
      Overrides:
      toString in class Object
      Returns:
      The word's text