io.lettuce.core.search.arguments

Class NumericFieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

io.lettuce.core.search.arguments.NumericFieldArgs

public class NumericFieldArgs
extends FieldArgs

Field arguments for NUMERIC fields in a RediSearch index.

Numeric fields are used to store non-textual, countable values. They can hold integer or floating-point values. Numeric fields are sortable, meaning you can perform range-based queries and retrieve documents based on specific numeric conditions. For example, you can search for documents with a price between a certain range or retrieve documents with a specific rating value.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Numeric Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumericFieldArgs.Builder Builder for NumericFieldArgs.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
NumericFieldArgs()

Method Summary

Modifier and Type	Method and Description
static NumericFieldArgs.Builder	builder() Create a new NumericFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
String	getFieldType() Returns the field type.

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

build, getAs, getName, isIndexEmpty, isIndexMissing, isNoIndex, isSortable, isUnNormalizedForm

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericFieldArgs

public NumericFieldArgs()

Method Detail

builder

public static NumericFieldArgs.Builder builder()

Create a new NumericFieldArgs using the builder pattern.

Returns:

a new NumericFieldArgs.Builder

getFieldType

public String getFieldType()

Description copied from class: FieldArgs

Returns the field type. Subclasses must implement this method.

Specified by:

getFieldType in class FieldArgs

Returns:

the field type

buildTypeSpecificArgs

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

Description copied from class: FieldArgs

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

Specified by:

buildTypeSpecificArgs in class FieldArgs

Parameters:

args - the command arguments to modify