org.springframework.data.redis.core

Interface GeoOperations<K,M>

public interface GeoOperations<K,M>

Redis operations for geo commands.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl, Mark Paluch

See Also:

Redis Documentation: Geo Commands

Method Summary

Modifier and Type	Method and Description
Long	add(K key, Iterable<RedisGeoCommands.GeoLocation<M>> locations) Add RedisGeoCommands.GeoLocations to key
Long	add(K key, Map<M,Point> memberCoordinateMap) Add Map of member / Point pairs to key.
Long	add(K key, Point point, M member) Add Point with given member name to key.
Long	add(K key, RedisGeoCommands.GeoLocation<M> location) Add RedisGeoCommands.GeoLocation to key.
Distance	distance(K key, M member1, M member2) Get the Distance between member1 and member2.
Distance	distance(K key, M member1, M member2, Metric metric) Get the Distance between member1 and member2 in the given Metric.
default Long	geoAdd(K key, Iterable<RedisGeoCommands.GeoLocation<M>> locations) Deprecated. since 2.0, use add(Object, Iterable).
default Long	geoAdd(K key, Map<M,Point> memberCoordinateMap) Deprecated. since 2.0, use add(Object, Map).
default Long	geoAdd(K key, Point point, M member) Deprecated. since 2.0, use add(Object, Point, Object).
default Long	geoAdd(K key, RedisGeoCommands.GeoLocation<M> location) Deprecated. since 2.0, use #add(Object, GeoLocation).
default Distance	geoDist(K key, M member1, M member2) Deprecated. since 2.0, use distance(Object, Object, Object).
default Distance	geoDist(K key, M member1, M member2, Metric metric) Deprecated. since 2.0, use distance(Object, Object, Object, Metric).
default List<String>	geoHash(K key, M... members) Deprecated. since 2.0, use hash(Object, Object[]).
default List<Point>	geoPos(K key, M... members) Deprecated. since 2.0, use position(Object, Object[]).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadius(K key, Circle within) Deprecated. since 2.0, use radius(Object, Circle).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadius(K key, Circle within, RedisGeoCommands.GeoRadiusCommandArgs args) Deprecated. since 2.0, use #radius(Object, Circle, GeoRadiusCommandArgs).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(K key, M member, Distance distance) Deprecated. since 2.0, use radius(Object, Object, Distance).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(K key, M member, Distance distance, RedisGeoCommands.GeoRadiusCommandArgs args) Deprecated. since 2.0, use #radius(Object, Object, Distance, GeoRadiusCommandArgs).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(K key, M member, double radius) Deprecated. since 2.0, use radius(Object, Object, double).
default Long	geoRemove(K key, M... members) Deprecated. since 2.0, use remove(Object, Object[]).
List<String>	hash(K key, M... members) Get Geohash representation of the position for one or more members.
List<Point>	position(K key, M... members) Get the Point representation of positions for one or more members.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(K key, Circle within) Get the members within the boundaries of a given Circle.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(K key, Circle within, RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(K key, M member, Distance distance) Get the members within the circle defined by the members coordinates and given radius applying Metric.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(K key, M member, Distance distance, RedisGeoCommands.GeoRadiusCommandArgs args) Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(K key, M member, double radius) Get the members within the circle defined by the members coordinates and given radius.
Long	remove(K key, M... members) Remove the members.

Method Detail

add

@Nullable
Long add(K key,
                   Point point,
                   M member)

Add Point with given member name to key.

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOADD

geoAdd

@Deprecated
 @Nullable
default Long geoAdd(K key,
                                           Point point,
                                           M member)

Deprecated. since 2.0, use add(Object, Point, Object).

Add Point with given member name to key.

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

add

@Nullable
Long add(K key,
                   RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOADD

geoAdd

@Deprecated
 @Nullable
default Long geoAdd(K key,
                                           RedisGeoCommands.GeoLocation<M> location)

Deprecated. since 2.0, use #add(Object, GeoLocation).

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

add

@Nullable
Long add(K key,
                   Map<M,Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOADD

geoAdd

@Deprecated
 @Nullable
default Long geoAdd(K key,
                                           Map<M,Point> memberCoordinateMap)

Deprecated. since 2.0, use add(Object, Map).

Add Map of member / Point pairs to key.

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

add

@Nullable
Long add(K key,
                   Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOADD

geoAdd

@Deprecated
 @Nullable
default Long geoAdd(K key,
                                           Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Deprecated. since 2.0, use add(Object, Iterable).

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added. null when used in pipeline / transaction.

See Also:

Redis Documentation: GEOADD

distance

@Nullable
Distance distance(K key,
                            M member1,
                            M member2)

Get the Distance between member1 and member2.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

Since:

2.0

See Also:

Redis Documentation: GEODIST

geoDist

@Deprecated
 @Nullable
default Distance geoDist(K key,
                                                M member1,
                                                M member2)

Deprecated. since 2.0, use distance(Object, Object, Object).

Get the Distance between member1 and member2.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: GEODIST

distance

@Nullable
Distance distance(K key,
                            M member1,
                            M member2,
                            Metric metric)

Get the Distance between member1 and member2 in the given Metric.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

metric - must not be null.

Returns:

can be null.

Since:

2.0

See Also:

Redis Documentation: GEODIST

geoDist

@Deprecated
 @Nullable
default Distance geoDist(K key,
                                                M member1,
                                                M member2,
                                                Metric metric)

Deprecated. since 2.0, use distance(Object, Object, Object, Metric).

Get the Distance between member1 and member2 in the given Metric.

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

metric - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: GEODIST

hash

@Nullable
List<String> hash(K key,
                            M... members)

Get Geohash representation of the position for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOHASH

geoHash

@Deprecated
 @Nullable
default List<String> geoHash(K key,
                                                    M... members)

Deprecated. since 2.0, use hash(Object, Object[]).

Get Geohash representation of the position for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEOHASH

position

@Nullable
List<Point> position(K key,
                               M... members)

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOPOS

geoPos

@Deprecated
 @Nullable
default List<Point> geoPos(K key,
                                                  M... members)

Deprecated. since 2.0, use position(Object, Object[]).

Get the Point representation of positions for one or more members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEOPOS

radius

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> radius(K key,
                                                             Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUS

geoRadius

@Deprecated
 @Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                                                     Circle within)

Deprecated. since 2.0, use radius(Object, Circle).

Get the members within the boundaries of a given Circle.

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUS

radius

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> radius(K key,
                                                             Circle within,
                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUS

geoRadius

@Deprecated
 @Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                                                     Circle within,
                                                                                     RedisGeoCommands.GeoRadiusCommandArgs args)

Deprecated. since 2.0, use #radius(Object, Circle, GeoRadiusCommandArgs).

Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUS

radius

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> radius(K key,
                                                             M member,
                                                             double radius)

Get the members within the circle defined by the members coordinates and given radius.

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

@Deprecated
 @Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                                             M member,
                                                                                             double radius)

Deprecated. since 2.0, use radius(Object, Object, double).

Get the members within the circle defined by the members coordinates and given radius.

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

radius

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> radius(K key,
                                                             M member,
                                                             Distance distance)

Get the members within the circle defined by the members coordinates and given radius applying Metric.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

@Deprecated
 @Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                                             M member,
                                                                                             Distance distance)

Deprecated. since 2.0, use radius(Object, Object, Distance).

Get the members within the circle defined by the members coordinates and given radius applying Metric.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

radius

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> radius(K key,
                                                             M member,
                                                             Distance distance,
                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

@Deprecated
 @Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                                             M member,
                                                                                             Distance distance,
                                                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

Deprecated. since 2.0, use #radius(Object, Object, Distance, GeoRadiusCommandArgs).

Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

remove

@Nullable
Long remove(K key,
                      M... members)

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed. null when used in pipeline / transaction.

Since:

2.0

geoRemove

@Deprecated
 @Nullable
default Long geoRemove(K key,
                                              M... members)

Deprecated. since 2.0, use remove(Object, Object[]).

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed. null when used in pipeline / transaction.