Package com.day.cq.spellchecker

Interface SpellCheckService

  • public interface SpellCheckService
    This interface must be implemented by all services that provide means for spellchecking a single word or an entire text.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      TextCheckResult checkText​(java.lang.String text, java.lang.String language, boolean isHtml, java.lang.String[] dictionaryPaths)
      Spellchecks an entire text.
      WordCheckResult checkWord​(java.lang.String word, java.lang.String language, java.lang.String[] dictionaryPaths)
      Spellchecks a single word.

    • Method Detail

      • checkWord

        WordCheckResult checkWord​(java.lang.String word,
                          java.lang.String language,
                          java.lang.String[] dictionaryPaths)
                   throws SpellCheckException
        Spellchecks a single word.
        Parameters:
        word - The word to spellcheck
        language - Language of the word
        dictionaryPaths - Paths to dictionaries
        Returns:
        The result of the spellchecking
        Throws:
        SpellCheckException - in case of an error

      • checkText

        TextCheckResult checkText​(java.lang.String text,
                          java.lang.String language,
                          boolean isHtml,
                          java.lang.String[] dictionaryPaths)
                   throws SpellCheckException
        Spellchecks an entire text.
        Parameters:
        text - The text to spellcheck
        language - Language of the text
        isHtml - True if the text to check is in HTML format
        dictionaryPaths - Paths to dictionaries
        Returns:
        The result of the spellchecking
        Throws:
        SpellCheckException - in case of an error