io.lettuce.core.search.arguments

Class FieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

Direct Known Subclasses:

GeoFieldArgs, GeoshapeFieldArgs, NumericFieldArgs, TagFieldArgs, TextFieldArgs, VectorFieldArgs

public abstract class FieldArgs
extends Object

Base class for field arguments in a RediSearch index.

This class contains common options shared by all field types. Specific field types should extend this class and add their type-specific options.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Field and type options

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldArgs.Builder<T extends FieldArgs,B extends FieldArgs.Builder<T,B>> Base builder for field arguments.

Field Summary

Fields

Modifier and Type	Field and Description
protected Optional<String>	as
protected boolean	indexEmpty
protected boolean	indexMissing
protected String	name
protected boolean	noIndex
protected boolean	sortable
protected boolean	unNormalizedForm

Constructor Summary

Constructors

Constructor and Description
FieldArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<?,?> args) Build the field arguments into the command.
protected abstract void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
Optional<String>	getAs() Get the field alias.
abstract String	getFieldType() Returns the field type.
String	getName() Get the indexed field: a hash field name or a JSONPath expression.
boolean	isIndexEmpty() Check if the field indexes empty values.
boolean	isIndexMissing() Check if the field indexes missing values.
boolean	isNoIndex() Check if the field is not indexed.
boolean	isSortable() Check if the field is sortable.
boolean	isUnNormalizedForm() Check if the field uses unnormalized form.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

as

protected Optional<String> as

sortable

protected boolean sortable

unNormalizedForm

protected boolean unNormalizedForm

noIndex

protected boolean noIndex

indexEmpty

protected boolean indexEmpty

indexMissing

protected boolean indexMissing

Constructor Detail

FieldArgs

public FieldArgs()

Method Detail

getFieldType

public abstract String getFieldType()

Returns the field type. Subclasses must implement this method.

Returns:

the field type

getName

public String getName()

Get the indexed field: a hash field name or a JSONPath expression.

Returns:

the hash field name or JSONPath expression

getAs

public Optional<String> getAs()

Get the field alias.

Returns:

the field alias

isSortable

public boolean isSortable()

Check if the field is sortable.

Returns:

true if sortable

isUnNormalizedForm

public boolean isUnNormalizedForm()

Check if the field uses unnormalized form.

Returns:

true if unnormalized form

isNoIndex

public boolean isNoIndex()

Check if the field is not indexed.

Returns:

true if not indexed

isIndexEmpty

public boolean isIndexEmpty()

Check if the field indexes empty values.

Returns:

true if indexes empty values

isIndexMissing

public boolean isIndexMissing()

Check if the field indexes missing values.

Returns:

true if indexes missing values

build

public final void build(CommandArgs<?,?> args)

Build the field arguments into the command.

Parameters:

args - the command arguments to modify

buildTypeSpecificArgs

protected abstract void buildTypeSpecificArgs(CommandArgs<?,?> args)

Add type-specific arguments to the command. Subclasses should override this method to add their specific arguments.

Parameters:

args - the command arguments to modify