io.lettuce.core.search.arguments

Class TextFieldArgs.Builder<K>

java.lang.Object

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

io.lettuce.core.search.arguments.TextFieldArgs.Builder<K>

Type Parameters:

K - Key type

Enclosing class:

TextFieldArgs<K>

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

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<K>	noStem() By default, the index applies stemming to TEXT fields.
TextFieldArgs.Builder<K>	phonetic(TextFieldArgs.PhoneticMatcher matcher) Phonetic matching is a feature that allows you to search for similar-sounding words.
TextFieldArgs.Builder<K>	weight(long weight) The weight of the field.
TextFieldArgs.Builder<K>	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<K> 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<K> 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<K> 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<K> 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