org.springframework.data.redis.connection

Class RedisGeoCommands.GeoSearchCommandArgs

java.lang.Object

org.springframework.data.redis.connection.RedisGeoCommands.GeoSearchCommandArgs

All Implemented Interfaces:

Cloneable, RedisGeoCommands.GeoCommandArgs

Direct Known Subclasses:

RedisGeoCommands.GeoRadiusCommandArgs

Enclosing interface:

RedisGeoCommands

public static class RedisGeoCommands.GeoSearchCommandArgs
extends Object
implements RedisGeoCommands.GeoCommandArgs, Cloneable

Additional arguments (like count/sort/...) to be used with RedisGeoCommands.

Since:

2.6

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisGeoCommands.GeoCommandArgs

RedisGeoCommands.GeoCommandArgs.GeoCommandFlag

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<RedisGeoCommands.GeoCommandArgs.GeoCommandFlag>	flags
protected Long	limit
protected org.springframework.data.domain.Sort.Direction	sortDirection

Method Summary

Modifier and Type	Method and Description
protected RedisGeoCommands.GeoSearchCommandArgs	clone()
Set<? extends RedisGeoCommands.GeoCommandArgs.GeoCommandFlag>	getFlags()
Long	getLimit()
org.springframework.data.domain.Sort.Direction	getSortDirection()
boolean	hasAnyLimit()
RedisGeoCommands.GeoSearchCommandArgs	includeCoordinates() Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD flag to also return the longitude, latitude coordinates of the matching items.
RedisGeoCommands.GeoSearchCommandArgs	includeDistance() Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST flag to also return the distance of the returned items from the specified center.
RedisGeoCommands.GeoSearchCommandArgs	limit(long count) Limit the results to the first N matching items.
RedisGeoCommands.GeoSearchCommandArgs	limit(long count, boolean any) Limit the results to the first N matching items.
static RedisGeoCommands.GeoSearchCommandArgs	newGeoSearchArgs() Create new RedisGeoCommands.GeoSearchCommandArgs.
RedisGeoCommands.GeoSearchCommandArgs	sort(org.springframework.data.domain.Sort.Direction direction) Apply a sort direction.
RedisGeoCommands.GeoSearchCommandArgs	sortAscending() Sort returned items from the nearest to the furthest, relative to the center.
RedisGeoCommands.GeoSearchCommandArgs	sortDescending() Sort returned items from the furthest to the nearest, relative to the center.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.RedisGeoCommands.GeoCommandArgs

hasFlags, hasLimit, hasSortDirection

Field Detail

flags

protected final Set<RedisGeoCommands.GeoCommandArgs.GeoCommandFlag> flags

limit

@Nullable
protected Long limit

sortDirection

@Nullable
protected org.springframework.data.domain.Sort.Direction sortDirection

Method Detail

newGeoSearchArgs

public static RedisGeoCommands.GeoSearchCommandArgs newGeoSearchArgs()

Create new RedisGeoCommands.GeoSearchCommandArgs.

Returns:

never null.

includeCoordinates

public RedisGeoCommands.GeoSearchCommandArgs includeCoordinates()

Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHCOORD flag to also return the longitude, latitude coordinates of the matching items.

Returns:

includeDistance

public RedisGeoCommands.GeoSearchCommandArgs includeDistance()

Sets the RedisGeoCommands.GeoRadiusCommandArgs.Flag.WITHDIST flag to also return the distance of the returned items from the specified center.

Returns:

never null.

sort

public RedisGeoCommands.GeoSearchCommandArgs sort(org.springframework.data.domain.Sort.Direction direction)

Apply a sort direction.

Returns:

never null.

sortAscending

public RedisGeoCommands.GeoSearchCommandArgs sortAscending()

Sort returned items from the nearest to the furthest, relative to the center.

Returns:

never null.

sortDescending

public RedisGeoCommands.GeoSearchCommandArgs sortDescending()

Sort returned items from the furthest to the nearest, relative to the center.

Returns:

never null.

limit

public RedisGeoCommands.GeoSearchCommandArgs limit(long count)

Limit the results to the first N matching items.

Parameters:

count -

Returns:

never null.

limit

public RedisGeoCommands.GeoSearchCommandArgs limit(long count,
                                                   boolean any)

Limit the results to the first N matching items.

Parameters:

count -

any -

Returns:

never null.

getFlags

public Set<? extends RedisGeoCommands.GeoCommandArgs.GeoCommandFlag> getFlags()

Specified by:

getFlags in interface RedisGeoCommands.GeoCommandArgs

Returns:

never null.

getLimit

@Nullable
public Long getLimit()

Specified by:

getLimit in interface RedisGeoCommands.GeoCommandArgs

Returns:

can be null.

getSortDirection

@Nullable
public org.springframework.data.domain.Sort.Direction getSortDirection()

Specified by:

getSortDirection in interface RedisGeoCommands.GeoCommandArgs

Returns:

can be null.

hasAnyLimit

public boolean hasAnyLimit()

clone

protected RedisGeoCommands.GeoSearchCommandArgs clone()

Overrides:

clone in class Object