Package org.redisson.api.search.index

Class TagIndexParams

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

  • Method Details

    • as

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

    • separator

      public TagIndexParams separator(String separator)
      Description copied from interface: TagIndex
      Defines separator used for splitting the value of this attribute. The separator value must be a single character.

      Default is ,

      Specified by:
      separator in interface TagIndex
      Parameters:
      separator - separator value
      Returns:
      options object

    • sortMode

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

    • caseSensitive

      public TagIndexParams caseSensitive()
      Description copied from interface: TagIndex
      Defines whether to keep the original letter cases of the tags. If not defined, the characters are converted to lowercase.
      Specified by:
      caseSensitive in interface TagIndex
      Returns:
      options object

    • noIndex

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

    • withSuffixTrie

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

    • indexEmpty

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

    • indexMissing

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

    • getFieldName

      public String getFieldName()

    • getAs

      public String getAs()

    • getSortMode

      public SortMode getSortMode()

    • isCaseSensitive

      public boolean isCaseSensitive()

    • isNoIndex

      public boolean isNoIndex()

    • isWithSuffixTrie

      public boolean isWithSuffixTrie()

    • getSeparator

      public String getSeparator()

    • isIndexEmpty

      public boolean isIndexEmpty()

    • isIndexMissing

      public boolean isIndexMissing()