io.lettuce.core.search.arguments

Class GeoshapeFieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

io.lettuce.core.search.arguments.GeoshapeFieldArgs

public class GeoshapeFieldArgs
extends FieldArgs

Field arguments for GEOSHAPE fields in a RediSearch index.

Geoshape fields provide more advanced functionality than GEO fields. You can use them to represent locations as points but also to define shapes and query the interactions between points and shapes (for example, to find all points that are contained within an enclosing shape). You can also choose between geographical coordinates (on the surface of a sphere) or standard Cartesian coordinates.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Geoshape Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoshapeFieldArgs.Builder Builder for GeoshapeFieldArgs.
static class	GeoshapeFieldArgs.CoordinateSystem Coordinate system for geoshape fields.

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
GeoshapeFieldArgs()

Method Summary

Modifier and Type	Method and Description
static GeoshapeFieldArgs.Builder	builder() Create a new GeoshapeFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
Optional<GeoshapeFieldArgs.CoordinateSystem>	getCoordinateSystem() Get the coordinate system.
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

GeoshapeFieldArgs

public GeoshapeFieldArgs()

Method Detail

builder

public static GeoshapeFieldArgs.Builder builder()

Create a new GeoshapeFieldArgs using the builder pattern.

Returns:

a new GeoshapeFieldArgs.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

getCoordinateSystem

public Optional<GeoshapeFieldArgs.CoordinateSystem> getCoordinateSystem()

Get the coordinate system.

Returns:

the coordinate system

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