Package org.redisson.api.search.index

Class TextIndexParams

java.lang.Object
org.redisson.api.search.index.TextIndexParams
All Implemented Interfaces:
FieldIndex, TextIndex
public final class TextIndexParams extends Object implements TextIndex
Author:
Nikita Koksharov

  • Method Details

    • as

      public TextIndexParams as(String as)
      Description copied from interface: TextIndex
      Defines the attribute associated to the field name.
      Specified by:
      as in interface TextIndex
      Parameters:
      as - the associated attribute
      Returns:
      options object

    • sortMode

      public TextIndexParams sortMode(SortMode sortMode)
      Description copied from interface: TextIndex
      Defines sort mode applied to the value of this attribute.
      Specified by:
      sortMode in interface TextIndex
      Parameters:
      sortMode - sort mode
      Returns:
      options object

    • noStem

      public TextIndexParams noStem()
      Description copied from interface: TextIndex
      Defines whether to disable stemming when indexing its values.
      Specified by:
      noStem in interface TextIndex
      Returns:
      options object

    • noIndex

      public TextIndexParams noIndex()
      Description copied from interface: TextIndex
      Defines to not index this attribute
      Specified by:
      noIndex in interface TextIndex
      Returns:
      options object

    • withSuffixTrie

      public TextIndexParams withSuffixTrie()
      Description copied from interface: TextIndex
      Defines whether to keep a suffix trie with all terms which match the suffix.
      Specified by:
      withSuffixTrie in interface TextIndex
      Returns:
      options object

    • phonetic

      public TextIndexParams phonetic(PhoneticMatcher matcher)
      Description copied from interface: TextIndex
      Defines phonetic matcher algorithm and language used for search result matching.
      Specified by:
      phonetic in interface TextIndex
      Parameters:
      matcher - phonetic matcher algorithm and language
      Returns:
      options object

    • weight

      public TextIndexParams weight(Double weight)
      Description copied from interface: TextIndex
      Defines declares a multiplication factor value used to declare the importance of this attribute when calculating result accuracy.
      Specified by:
      weight in interface TextIndex
      Parameters:
      weight - multiplication factor value
      Returns:
      options object

    • indexEmpty

      public TextIndexParams indexEmpty()
      Description copied from interface: TextIndex
      Defines whether to index an empty value.
      Specified by:
      indexEmpty in interface TextIndex
      Returns:
      options object

    • indexMissing

      public TextIndexParams indexMissing()
      Description copied from interface: TextIndex
      Defines to index documents that don't contain this attribute
      Specified by:
      indexMissing in interface TextIndex
      Returns:
      options object

    • getFieldName

      public String getFieldName()

    • getAs

      public String getAs()

    • getSortMode

      public SortMode getSortMode()

    • isNoIndex

      public boolean isNoIndex()

    • isNoStem

      public boolean isNoStem()

    • getMatcher

      public PhoneticMatcher getMatcher()

    • isWithSuffixTrie

      public boolean isWithSuffixTrie()

    • getWeight

      public Double getWeight()

    • isIndexEmpty

      public boolean isIndexEmpty()

    • isIndexMissing

      public boolean isIndexMissing()