Package com.jalios.jcms.spellchecker

Interface SpellChecker

  • All Known Implementing Classes:
    XMLmindSpellChecker
    public interface SpellChecker
    Interface to be implemented to provide a SpellChecker for JCMS.
    Since:
    jcms-6.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getLanguageList()
      Returns a list of available languages for spell-checking.
      java.util.List<SpellCheckResult> spellCheck​(java.lang.String text, java.lang.String lang)
      Spell-check the specified text in the specified language and return a list of SpellCheckResult.

    • Method Detail

      • getLanguageList

        java.util.List<java.lang.String> getLanguageList()
        Returns a list of available languages for spell-checking.
        Returns:
        a List of ISO-639 language code

      • spellCheck

        java.util.List<SpellCheckResult> spellCheck​(java.lang.String text,
                                            java.lang.String lang)
        Spell-check the specified text in the specified language and return a list of SpellCheckResult.
        Parameters:
        text - the text to check
        lang - the language of the text (ISO-639 code), never null or empty
        Returns:
        a List of SpellCheckResult