org.springframework.data.redis.connection

Interface RedisGeoCommands

All Known Subinterfaces:

RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisGeoCommands

Geo-specific Redis commands.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedisGeoCommands.DistanceUnit Metrics supported by Redis.
static class	RedisGeoCommands.GeoLocation<T> RedisGeoCommands.GeoLocation representing a Point associated with a name.
static class	RedisGeoCommands.GeoRadiusCommandArgs Additional arguments (like count/sort/...) to be used with RedisGeoCommands.

Method Summary

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

Method Detail

geoAdd

Long geoAdd(byte[] key,
            Point point,
            byte[] 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.

See Also:

http://redis.io/commands/geoadd

geoAdd

Long geoAdd(byte[] key,
            RedisGeoCommands.GeoLocation<byte[]> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

key - must not be null.

location - must not be null.

Returns:

Number of elements added.

See Also:

http://redis.io/commands/geoadd

geoAdd

Long geoAdd(byte[] key,
            Map<byte[],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.

See Also:

http://redis.io/commands/geoadd

geoAdd

Long geoAdd(byte[] key,
            Iterable<RedisGeoCommands.GeoLocation<byte[]>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

key - must not be null.

locations - must not be null.

Returns:

Number of elements added.

See Also:

http://redis.io/commands/geoadd

geoDist

Distance geoDist(byte[] key,
                 byte[] member1,
                 byte[] 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.

See Also:

http://redis.io/commands/geodist

geoDist

Distance geoDist(byte[] key,
                 byte[] member1,
                 byte[] 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.

See Also:

http://redis.io/commands/geodist

geoHash

List<String> geoHash(byte[] key,
                     byte[]... 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.

See Also:

http://redis.io/commands/geohash

geoPos

List<Point> geoPos(byte[] key,
                   byte[]... 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.

See Also:

http://redis.io/commands/geopos

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte[] 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.

See Also:

http://redis.io/commands/georadius

geoRadius

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadius(byte[] 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.

See Also:

http://redis.io/commands/georadius

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                   byte[] 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.

See Also:

http://redis.io/commands/georadiusbymember

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                   byte[] member,
                                                                   Distance radius)

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

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

Returns:

never null.

See Also:

http://redis.io/commands/georadiusbymember

geoRadiusByMember

GeoResults<RedisGeoCommands.GeoLocation<byte[]>> geoRadiusByMember(byte[] key,
                                                                   byte[] member,
                                                                   Distance radius,
                                                                   RedisGeoCommands.GeoRadiusCommandArgs args)

Get the members within the circle defined by the members coordinates, given Distance and RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

key - must not be null.

member - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null.

See Also:

http://redis.io/commands/georadiusbymember

geoRemove

Long geoRemove(byte[] key,
               byte[]... members)

Remove the members.

Parameters:

key - must not be null.

members - must not be null.

Returns:

Number of elements removed.