io.lettuce.core.search.arguments

Class FieldArgs.Builder<K,T extends FieldArgs<K>,B extends FieldArgs.Builder<K,T,B>>

java.lang.Object

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

Type Parameters:

K - Key type

T - The concrete field args type

B - The concrete builder type

Direct Known Subclasses:

GeoFieldArgs.Builder, GeoshapeFieldArgs.Builder, NumericFieldArgs.Builder, TagFieldArgs.Builder, TextFieldArgs.Builder, VectorFieldArgs.Builder

Enclosing class:

FieldArgs<K>

public abstract static class FieldArgs.Builder<K,T extends FieldArgs<K>,B extends FieldArgs.Builder<K,T,B>>
extends Object

Base builder for field arguments.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	instance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(T instance) Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
B	as(K as) Defines the attribute associated to the identifier.
T	build() Build the field arguments.
B	indexEmpty() For TEXT and TAG attributes, introduced in v2.10, allows you to index and search for empty strings.
B	indexMissing() For all field types, introduced in v2.10, allows you to search for missing values, that is, documents that do not contain a specific field.
B	name(K name) The name of the field in a hash the index is going to be based on.
B	noIndex() Attributes can have the NOINDEX option, which means they will not be indexed.
protected B	self() Returns this builder instance for method chaining.
B	sortable() NUMERIC, TAG, TEXT, or GEO attributes can have an optional SORTABLE argument.
B	unNormalizedForm() By default, for hashes (not with JSON) SORTABLE applies normalization to the indexed value (characters set to lowercase, removal of diacritics).

Methods inherited from class java.lang.Object

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

Field Detail

instance

protected final T extends FieldArgs<K> instance

Constructor Detail

Builder

protected Builder(T instance)

Constructor for subclasses.

Parameters:

instance - the field args instance to build

Method Detail

self

protected B self()

Returns this builder instance for method chaining.

Returns:

this builder instance

name

public B name(K name)

The name of the field in a hash the index is going to be based on.

Parameters:

name - the name of the field

Returns:

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

as

public B as(K as)

Defines the attribute associated to the identifier. For example, you can use this feature to alias a complex JSONPath expression with more memorable (and easier to type) name.

Parameters:

as - the field name to be used in queries

Returns:

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

sortable

public B sortable()

NUMERIC, TAG, TEXT, or GEO attributes can have an optional SORTABLE argument. As the user sorts the results by the value of this attribute, the results are available with very low latency. Default is false (not sortable).

Note that this adds memory overhead, so consider not declaring it on large text attributes. You can sort an attribute without the SORTABLE option, but the latency is not as good as with SORTABLE.

Returns:

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

unNormalizedForm

public B unNormalizedForm()

By default, for hashes (not with JSON) SORTABLE applies normalization to the indexed value (characters set to lowercase, removal of diacritics). When using the unnormalized form (UNF), you can disable the normalization and keep the original form of the value. With JSON, UNF is implicit with SORTABLE (normalization is disabled).

Default is false (normalized form).

Returns:

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

noIndex

public B noIndex()

Attributes can have the NOINDEX option, which means they will not be indexed. This is useful in conjunction with sortable(), to create attributes whose update using PARTIAL will not cause full reindexing of the document. If an attribute has NOINDEX and doesn't have SORTABLE, it will just be ignored by the index.

Returns:

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

indexEmpty

public B indexEmpty()

For TEXT and TAG attributes, introduced in v2.10, allows you to index and search for empty strings. By default, empty strings are not indexed.

Returns:

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

indexMissing

public B indexMissing()

For all field types, introduced in v2.10, allows you to search for missing values, that is, documents that do not contain a specific field. Note the difference between a field with an empty value and a document with a missing value. By default, missing values are not indexed.

Returns:

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

build

public T build()

Build the field arguments.

Returns:

the field arguments instance