com.groupdocs.search.options

Class SpellingCorrectorOptions



  • public class SpellingCorrectorOptions
    extends Object

    Provides options for the spelling corrector.

    • Constructor Detail

      • SpellingCorrectorOptions

        protected SpellingCorrectorOptions()

        Initializes a new instance of the SpellingCorrectorOptions class.

    • Method Detail

      • getEnabled

        public final boolean getEnabled()

        Gets a value indicating whether the spelling corrector is enabled. The default value is false.

        Returns:
        A value indicating whether the spelling corrector is enabled.
      • setEnabled

        public final void setEnabled(boolean value)

        Sets a value indicating whether the spelling corrector is enabled. The default value is false.

        Parameters:
        value - A value indicating whether the spelling corrector is enabled.
      • getMaxMistakeCount

        public final int getMaxMistakeCount()

        Gets the maximum number of mistakes. The default value is 2.

        Returns:
        The maximum number of mistakes.
      • setMaxMistakeCount

        public final void setMaxMistakeCount(int value)

        Sets the maximum number of mistakes. The default value is 2.

        Parameters:
        value - The maximum number of mistakes.
      • getOnlyBestResults

        public final boolean getOnlyBestResults()

        Gets a value indicating whether only the best results will be returned. The default value is false.

        Returns:
        true if only the best results will be returned; otherwise false.
      • setOnlyBestResults

        public final void setOnlyBestResults(boolean value)

        Sets a value indicating whether only the best results will be returned. The default value is false.

        Parameters:
        value - true if only the best results will be returned; otherwise false.
      • getOnlyBestResultsRange

        public final byte getOnlyBestResultsRange()

        Gets the maximum exceeding of the minimum number of mistakes that are found. The default value is 0.

        Returns:
        The maximum exceeding of the minimum number of mistakes found.
      • setOnlyBestResultsRange

        public final void setOnlyBestResultsRange(byte value)

        Sets the maximum exceeding of the minimum number of mistakes that are found. The default value is 0.

        Parameters:
        value - The maximum exceeding of the minimum number of mistakes found.
      • getConsiderTranspositions

        public final boolean getConsiderTranspositions()

        Gets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is true.

        Returns:
        true if the spelling corrector algorithm considers transpositions; otherwise false.
      • setConsiderTranspositions

        public final void setConsiderTranspositions(boolean value)

        Sets a value indicating whether the algorithm must consider transposition of two adjacent characters as a single mistake. The default value is true.

        Parameters:
        value - true if the spelling corrector algorithm considers transpositions; otherwise false.