org.springframework.data.redis.core

Interface BoundGeoOperations<K,M>

All Superinterfaces:

BoundKeyOperations<K>

public interface BoundGeoOperations<K,M>
extends BoundKeyOperations<K>

GeoOperations bound to a certain key.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
Long	add(Iterable<RedisGeoCommands.GeoLocation<M>> locations) Add RedisGeoCommands.GeoLocations to key
Long	add(Map<M,Point> memberCoordinateMap) Add Map of member / Point pairs to key.
Long	add(Point point, M member) Add Point with given member name to key.
Long	add(RedisGeoCommands.GeoLocation<M> location) Add RedisGeoCommands.GeoLocation to key.
Distance	distance(M member1, M member2) Get the Distance between member1 and member2.
Distance	distance(M member1, M member2, Metric metric) Get the Distance between member1 and member2 in the given Metric.
default Long	geoAdd(Iterable<RedisGeoCommands.GeoLocation<M>> locations) Deprecated. since 2.0, use add(Iterable).
default Long	geoAdd(Map<M,Point> memberCoordinateMap) Deprecated. since 2.0, use add(Map).
default Long	geoAdd(Point point, M member) Deprecated. since 2.0, use add(Point, Object).
default Long	geoAdd(RedisGeoCommands.GeoLocation<M> location) Deprecated. since 2.0, use #add(GeoLocation).
default Distance	geoDist(M member1, M member2) Deprecated. since 2.0, use distance(Object, Object).
default Distance	geoDist(M member1, M member2, Metric metric) Deprecated. since 2.0, use distance(Object, Object, Metric).
default List<String>	geoHash(M... members) Deprecated. since 2.0, use hash(Object[]).
default List<Point>	geoPos(M... members) Deprecated. since 2.0, use position(Object[]).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadius(Circle within) Deprecated. since 2.0, use radius(Circle).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadius(Circle within, RedisGeoCommands.GeoRadiusCommandArgs args) Deprecated. since 2.0, use #radius(Circle, GeoRadiusCommandArgs).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(K key, M member, double radius) Deprecated. since 2.0, use radius(Object, Object, double).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(M member, Distance distance) Deprecated. since 2.0, use radius(Object, Distance).
default GeoResults<RedisGeoCommands.GeoLocation<M>>	geoRadiusByMember(M member, Distance distance, RedisGeoCommands.GeoRadiusCommandArgs args) Deprecated. since 2.0, use #radius(Object, Distance, GeoRadiusCommandArgs).
default Long	geoRemove(M... members) Deprecated. since 2.0, use remove(Object[]).
List<String>	hash(M... members) Get Geohash representation of the position for one or more members.
List<Point>	position(M... members) Get the Point representation of positions for one or more members.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(Circle within) Get the members within the boundaries of a given Circle.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(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, double radius) Get the members within the circle defined by the members coordinates and given radius.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(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(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.
Long	remove(M... members) Remove the members.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(Circle within) Get the members within the boundaries of a given Circle.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(GeoReference<M> reference, BoundingBox boundingBox) Get the members using GeoReference as center of the query within the boundaries of a given bounding box.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(GeoReference<M> reference, BoundingBox boundingBox, RedisGeoCommands.GeoSearchCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(GeoReference<M> reference, Distance radius) Get the members using GeoReference as center of the query within the boundaries of a given radius.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(GeoReference<M> reference, Distance radius, RedisGeoCommands.GeoSearchCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<M>>	search(GeoReference<M> reference, GeoShape geoPredicate, RedisGeoCommands.GeoSearchCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.
default Long	searchAndStore(K destKey, Circle within) Get the members within the boundaries of a given Circle and store results at destKey.
default Long	searchAndStore(K destKey, GeoReference<M> reference, BoundingBox boundingBox) Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.
default Long	searchAndStore(K destKey, GeoReference<M> reference, BoundingBox boundingBox, RedisGeoCommands.GeoSearchStoreCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
default Long	searchAndStore(K destKey, GeoReference<M> reference, Distance radius) Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.
default Long	searchAndStore(K destKey, GeoReference<M> reference, Distance radius, RedisGeoCommands.GeoSearchStoreCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
Long	searchAndStore(K destKey, GeoReference<M> reference, GeoShape geoPredicate, RedisGeoCommands.GeoSearchStoreCommandArgs args) Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

expire, expire, expireAt, expireAt, getExpire, getKey, getType, persist, rename

Method Detail

add

@Nullable
Long add(Point point,
                   M member)

Add Point with given member name to key.

Parameters:

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(Point point,
                                           M member)

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

Add Point with given member name to key.

Parameters:

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(RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

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(RedisGeoCommands.GeoLocation<M> location)

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

Add RedisGeoCommands.GeoLocation to key.

Parameters:

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(Map<M,Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

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(Map<M,Point> memberCoordinateMap)

Deprecated. since 2.0, use add(Map).

Add Map of member / Point pairs to key.

Parameters:

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(Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

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(Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Deprecated. since 2.0, use add(Iterable).

Add RedisGeoCommands.GeoLocations to key

Parameters:

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(M member1,
                            M member2)

Get the Distance between member1 and member2.

Parameters:

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(M member1,
                                                M member2)

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

Get the Distance between member1 and member2.

Parameters:

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

See Also:

Redis Documentation: GEODIST

distance

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

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

Parameters:

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(M member1,
                                                M member2,
                                                Metric metric)

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

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

Parameters:

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(M... members)

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

Parameters:

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(M... members)

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

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

Parameters:

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEOHASH

position

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

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

Parameters:

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(M... members)

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

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

Parameters:

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(Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

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(Circle within)

Deprecated. since 2.0, use radius(Circle).

Get the members within the boundaries of a given Circle.

Parameters:

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(Circle within,
                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

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

Parameters:

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(Circle within,
                                                                                     RedisGeoCommands.GeoRadiusCommandArgs args)

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

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

Parameters:

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:

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:

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(M member,
                                                             Distance distance)

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

Parameters:

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(M member,
                                                                                             Distance distance)

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

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

Parameters:

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(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:

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(M member,
                                                                                             Distance distance,
                                                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

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

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

Parameters:

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(M... members)

Remove the members.

Parameters:

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(M... members)

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

Remove the members.

Parameters:

members - must not be null.

Returns:

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

search

@Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> search(Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

search

@Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> search(GeoReference<M> reference,
                                                                     Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius.

Parameters:

reference - must not be null.

radius - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

search

@Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> search(GeoReference<M> reference,
                                                                     Distance radius,
                                                                     RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

search

@Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> search(GeoReference<M> reference,
                                                                     BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box.

Parameters:

reference - must not be null.

boundingBox - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

search

@Nullable
default GeoResults<RedisGeoCommands.GeoLocation<M>> search(GeoReference<M> reference,
                                                                     BoundingBox boundingBox,
                                                                     RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

search

@Nullable
GeoResults<RedisGeoCommands.GeoLocation<M>> search(GeoReference<M> reference,
                                                             GeoShape geoPredicate,
                                                             RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCH

searchAndStore

@Nullable
default Long searchAndStore(K destKey,
                                      Circle within)

Get the members within the boundaries of a given Circle and store results at destKey.

Parameters:

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE

searchAndStore

@Nullable
default Long searchAndStore(K destKey,
                                      GeoReference<M> reference,
                                      Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.

Parameters:

reference - must not be null.

radius - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE

searchAndStore

@Nullable
default Long searchAndStore(K destKey,
                                      GeoReference<M> reference,
                                      Distance radius,
                                      RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE

searchAndStore

@Nullable
default Long searchAndStore(K destKey,
                                      GeoReference<M> reference,
                                      BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.

Parameters:

reference - must not be null.

boundingBox - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE

searchAndStore

@Nullable
default Long searchAndStore(K destKey,
                                      GeoReference<M> reference,
                                      BoundingBox boundingBox,
                                      RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE

searchAndStore

@Nullable
Long searchAndStore(K destKey,
                              GeoReference<M> reference,
                              GeoShape geoPredicate,
                              RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

Redis Documentation: GEOSEARCHSTORE