org.springframework.data.redis.core

Class DefaultGeoOperations<K,M>

java.lang.Object

org.springframework.data.redis.core.DefaultGeoOperations<K,M>

All Implemented Interfaces:

GeoOperations<K,M>

public class DefaultGeoOperations<K,M>
extends Object
implements GeoOperations<K,M>

Default implementation of GeoOperations.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

geoAdd

public Long geoAdd(K key,
                   Point point,
                   M member)

Description copied from interface: GeoOperations

Add Point with given member name to key.

Specified by:

geoAdd in interface GeoOperations<K,M>

Parameters:

key - must not be null.

point - must not be null.

member - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   RedisGeoCommands.GeoLocation<M> location)

Description copied from interface: GeoOperations

Add RedisGeoCommands.GeoLocation to key.

Specified by:

geoAdd in interface GeoOperations<K,M>

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   Map<M,Point> memberCoordinateMap)

Description copied from interface: GeoOperations

Add Map of member / Point pairs to key.

Specified by:

geoAdd in interface GeoOperations<K,M>

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoAdd

public Long geoAdd(K key,
                   Iterable<RedisGeoCommands.GeoLocation<M>> locations)

Description copied from interface: GeoOperations

Add RedisGeoCommands.GeoLocations to key

Specified by:

geoAdd in interface GeoOperations<K,M>

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added.

See Also:

Redis Documentation: GEOADD

geoDist

public Distance geoDist(K key,
                        M member1,
                        M member2)

Description copied from interface: GeoOperations

Get the Distance between member1 and member2.

Specified by:

geoDist in interface GeoOperations<K,M>

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

geoDist

public Distance geoDist(K key,
                        M member1,
                        M member2,
                        Metric metric)

Description copied from interface: GeoOperations

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

Specified by:

geoDist in interface GeoOperations<K,M>

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

geoHash

public List<String> geoHash(K key,
                            M... members)

Description copied from interface: GeoOperations

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

Specified by:

geoHash in interface GeoOperations<K,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEOHASH

geoPos

public List<Point> geoPos(K key,
                          M... members)

Description copied from interface: GeoOperations

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

Specified by:

geoPos in interface GeoOperations<K,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEOPOS

geoRadius

public GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                             Circle within)

Description copied from interface: GeoOperations

Get the members within the boundaries of a given Circle.

Specified by:

geoRadius in interface GeoOperations<K,M>

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUS

geoRadius

public GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                             Circle within,
                                                             RedisGeoCommands.GeoRadiusCommandArgs args)

Description copied from interface: GeoOperations

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

Specified by:

geoRadius in interface GeoOperations<K,M>

Parameters:

key - must not be null.

within - must not be null.

args - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUS

geoRadiusByMember

public GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                     M member,
                                                                     double radius)

Description copied from interface: GeoOperations

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

Specified by:

geoRadiusByMember in interface GeoOperations<K,M>

Parameters:

key - must not be null.

member - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

public GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                     M member,
                                                                     Distance distance)

Description copied from interface: GeoOperations

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

Specified by:

geoRadiusByMember in interface GeoOperations<K,M>

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

public GeoResults<RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                     M member,
                                                                     Distance distance,
                                                                     RedisGeoCommands.GeoRadiusCommandArgs param)

Description copied from interface: GeoOperations

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

Specified by:

geoRadiusByMember in interface GeoOperations<K,M>

Parameters:

key - must not be null.

member - must not be null.

distance - must not be null.

param - must not be null.

Returns:

never null.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRemove

public Long geoRemove(K key,
                      M... members)

Description copied from interface: GeoOperations

Remove the members.

Specified by:

geoRemove in interface GeoOperations<K,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed.

getOperations

public RedisOperations<K,V> getOperations()