Package org.redisson.api.search.index

Interface TextIndex

All Superinterfaces:
FieldIndex
All Known Implementing Classes:
TextIndexParams
public interface TextIndex extends FieldIndex
Text field index options.
Author:
Nikita Koksharov

  • Method Summary

    Modifier and Type
    Method
    Description
    TextIndex
    as(String as)
    Defines the attribute associated to the field name.
    TextIndex
    noIndex()
    Defines to not index this attribute
    TextIndex
    noStem()
    Defines whether to disable stemming when indexing its values.
    TextIndex
    phonetic(PhoneticMatcher matcher)
    Defines phonetic matcher algorithm and language used for search result matching.
    TextIndex
    sortMode(SortMode sortMode)
    Defines sort mode applied to the value of this attribute.
    TextIndex
    weight(Double weight)
    Defines declares a multiplication factor value used to declare the importance of this attribute when calculating result accuracy.
    TextIndex
    withSuffixTrie()
    Defines whether to keep a suffix trie with all terms which match the suffix.

  • Method Details

    • as

      TextIndex as(String as)
      Defines the attribute associated to the field name.
      Parameters:
      as - the associated attribute
      Returns:
      options object

    • sortMode

      TextIndex sortMode(SortMode sortMode)
      Defines sort mode applied to the value of this attribute.
      Parameters:
      sortMode - sort mode
      Returns:
      options object

    • noStem

      TextIndex noStem()
      Defines whether to disable stemming when indexing its values.
      Returns:
      options object

    • noIndex

      TextIndex noIndex()
      Defines to not index this attribute
      Returns:
      options object

    • withSuffixTrie

      TextIndex withSuffixTrie()
      Defines whether to keep a suffix trie with all terms which match the suffix.
      Returns:
      options object

    • phonetic

      TextIndex phonetic(PhoneticMatcher matcher)
      Defines phonetic matcher algorithm and language used for search result matching.
      Parameters:
      matcher - phonetic matcher algorithm and language
      Returns:
      options object

    • weight

      TextIndex weight(Double weight)
      Defines declares a multiplication factor value used to declare the importance of this attribute when calculating result accuracy.
      Parameters:
      weight - multiplication factor value
      Returns:
      options object