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

Method Summary

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

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

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

Method Detail

geoAdd

Long geoAdd(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.

See Also:

Redis Documentation: GEOADD

geoAdd

Long geoAdd(RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

location - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoAdd

Long geoAdd(Map<M,Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

memberCoordinateMap - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoAdd

Long geoAdd(Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

locations - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoDist

Distance geoDist(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.

See Also:

Redis Documentation: GEODIST

geoDist

Distance geoDist(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.

See Also:

Redis Documentation: GEODIST

geoHash

List<String> geoHash(M... members)

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

Parameters:

members - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEOHASH

geoPos

List<Point> geoPos(M... members)

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

Parameters:

members - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEOPOS

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

within - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUS

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(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.

See Also:

Redis Documentation: GEORADIUS

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(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.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(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.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(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.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRemove

Long geoRemove(M... members)

Remove the members.

Parameters:

members - must not be null.

Returns:

Number of elements removed.