Package org.redisson.api.search

Class SpellcheckOptions

java.lang.Object
org.redisson.api.search.SpellcheckOptions
public final class SpellcheckOptions extends Object
Spellcheck options for RSearch.spellcheck(String, String, SpellcheckOptions) method
Author:
Nikita Koksharov

  • Method Details

    • defaults

      public static SpellcheckOptions defaults()

    • distance

      public SpellcheckOptions distance(Integer distance)
      Defines maximum Levenshtein distance for spelling suggestions. Allowed values from 1 to 4.

      Default is 1

      Parameters:
      distance - maximum Levenshtein distance
      Returns:
      options object

    • dialect

      public SpellcheckOptions dialect(Integer dialect)
      Defines dialect version used for query execution.
      Parameters:
      dialect - dialect version
      Returns:
      options object

    • includedTerms

      public SpellcheckOptions includedTerms(String dictionary, String... includedTerms)
      Defines includedTerms of a custom dictionary.
      Parameters:
      dictionary - custom dictionary
      includedTerms - included terms
      Returns:
      options object

    • excludedTerms

      public SpellcheckOptions excludedTerms(String dictionary, String... excludedTerms)
      Defines excludedTerms of a custom dictionary.
      Parameters:
      dictionary - custom dictionary
      excludedTerms - excluded terms
      Returns:
      options object

    • getDistance

      public Integer getDistance()

    • getDialect

      public Integer getDialect()

    • getIncludedTerms

      public List<String> getIncludedTerms()

    • getExcludedTerms

      public List<String> getExcludedTerms()

    • getExcludedDictionary

      public String getExcludedDictionary()

    • getIncludedDictionary

      public String getIncludedDictionary()