Package org.omegat.core.spellchecker

Interface ISpellChecker

  • All Known Implementing Classes:
    SpellChecker
    public interface ISpellChecker
    Interface for access to spell checker.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void destroy()
      Destroy internal cache and free memory.
      java.util.List<Token> getMisspelledTokens​(java.lang.String text)
      Get a list of misspelled tokens from the given text
      void ignoreWord​(java.lang.String word)
      Add a word to the list of ignored words
      void initialize()
      Initialize spell checker for current project.
      boolean isCorrect​(java.lang.String word)
      Check the word.
      boolean isIgnoredWord​(java.lang.String word)
      Determine if the given word is on the ignored list
      boolean isLearnedWord​(java.lang.String word)
      Determine if the given word is on the learned list
      void learnWord​(java.lang.String word)
      Add a word to the list of correct words
      void saveWordLists()
      Save the word lists to disk
      java.util.List<java.lang.String> suggest​(java.lang.String word)
      return a list of strings as suggestions

    • Method Detail

      • initialize

        void initialize()
        Initialize spell checker for current project.

      • destroy

        void destroy()
        Destroy internal cache and free memory.

      • saveWordLists

        void saveWordLists()
        Save the word lists to disk

      • isCorrect

        boolean isCorrect​(java.lang.String word)
        Check the word. If it is ignored or learned (valid), returns true. Otherwise false.

      • suggest

        java.util.List<java.lang.String> suggest​(java.lang.String word)
        return a list of strings as suggestions

      • learnWord

        void learnWord​(java.lang.String word)
        Add a word to the list of correct words

      • ignoreWord

        void ignoreWord​(java.lang.String word)
        Add a word to the list of ignored words

      • getMisspelledTokens

        java.util.List<Token> getMisspelledTokens​(java.lang.String text)
        Get a list of misspelled tokens from the given text

      • isIgnoredWord

        boolean isIgnoredWord​(java.lang.String word)
        Determine if the given word is on the ignored list

      • isLearnedWord

        boolean isLearnedWord​(java.lang.String word)
        Determine if the given word is on the learned list