io.lettuce.core.search.arguments

Class TextFieldArgs.Builder

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs.Builder<TextFieldArgs,TextFieldArgs.Builder>

io.lettuce.core.search.arguments.TextFieldArgs.Builder

Enclosing class:

TextFieldArgs

public static class TextFieldArgs.Builder
extends FieldArgs.Builder<TextFieldArgs,TextFieldArgs.Builder>

Builder for TextFieldArgs.

Field Summary

Fields inherited from class io.lettuce.core.search.arguments.FieldArgs.Builder

instance

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TextFieldArgs.Builder	noStem() By default, the index applies stemming to TEXT fields.
TextFieldArgs.Builder	phonetic(TextFieldArgs.PhoneticMatcher matcher) Phonetic matching is a feature that allows you to search for similar-sounding words.
TextFieldArgs.Builder	weight(long weight) The weight of the field.
TextFieldArgs.Builder	withSuffixTrie() For TEXT attributes, keeps a suffix trie with all terms which match the suffix.

Methods inherited from class io.lettuce.core.search.arguments.FieldArgs.Builder

as, build, indexEmpty, indexMissing, name, noIndex, self, sortable, unNormalizedForm

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

weight

public TextFieldArgs.Builder weight(long weight)

The weight of the field. Works with TEXT attributes, declares the importance of this attribute when calculating result accuracy. This is a multiplication factor. The default weight is 1.

Parameters:

weight - the weight of the field

Returns:

the instance of the TextFieldArgs.Builder for the purpose of method chaining

noStem

public TextFieldArgs.Builder noStem()

By default, the index applies stemming to TEXT fields. If you don't want to apply stemming to the field, you can use the NOSTEM argument. This may be ideal for things like proper names.

Returns:

the instance of the TextFieldArgs.Builder for the purpose of method chaining

phonetic

public TextFieldArgs.Builder phonetic(TextFieldArgs.PhoneticMatcher matcher)

Phonetic matching is a feature that allows you to search for similar-sounding words. For example, a search for "Smith" will also return results for "Smyth". Phonetic matching is language-specific, and you can specify the language using the PHONETIC argument.

The following languages are supported:

• ENGLISH
• FRENCH
• PORTUGUESE
• SPANISH

Parameters:

matcher - the phonetic matcher

Returns:

the instance of the TextFieldArgs.Builder for the purpose of method chaining

See Also:

Phonetic Matching

withSuffixTrie

public TextFieldArgs.Builder withSuffixTrie()

For TEXT attributes, keeps a suffix trie with all terms which match the suffix. It is used to optimize contains (*foo*) and suffix (*foo) queries. Otherwise, a brute-force search on the trie is performed. If the suffix trie exists for some fields, these queries will be disabled for other fields.

Returns:

the instance of the TextFieldArgs.Builder for the purpose of method chaining