org.openingo.spring.boot.extension.data.redis.commands

Interface IGeoCommands<K,M>

All Known Subinterfaces:

IRedisCommands<K,V>

All Known Implementing Classes:

RedisIdEngine, RedisStringKeyTemplateX, RedisTemplateX

public interface IGeoCommands<K,M>

IGeoCommands

Author:

Qicz

Method Summary

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

Method Detail

geoAdd

@Nullable
Long geoAdd(K key,
                      org.springframework.data.geo.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.

See Also:

Redis Documentation: GEOADD

geoAdd

@Nullable
Long geoAdd(K key,
                      org.springframework.data.redis.connection.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.

See Also:

Redis Documentation: GEOADD

geoAdd

@Nullable
Long geoAdd(K key,
                      Map<M,org.springframework.data.geo.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.

See Also:

Redis Documentation: GEOADD

geoAdd

@Nullable
Long geoAdd(K key,
                      Iterable<org.springframework.data.redis.connection.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.

See Also:

Redis Documentation: GEOADD

geoDist

@Nullable
org.springframework.data.geo.Distance geoDist(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.

See Also:

Redis Documentation: GEODIST

geoDist

@Nullable
org.springframework.data.geo.Distance geoDist(K key,
                                                        M member1,
                                                        M member2,
                                                        org.springframework.data.geo.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:

Redis Documentation: GEODIST

geoHash

@Nullable
List<String> geoHash(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.

See Also:

Redis Documentation: GEOHASH

geoPos

@Nullable
List<org.springframework.data.geo.Point> geoPos(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.

See Also:

Redis Documentation: GEOPOS

geoRadius

@Nullable
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                                                                                                       org.springframework.data.geo.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.

See Also:

Redis Documentation: GEORADIUS

geoRadius

@Nullable
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoRadius(K key,
                                                                                                                                       org.springframework.data.geo.Circle within,
                                                                                                                                       org.springframework.data.redis.connection.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.

See Also:

Redis Documentation: GEORADIUS

geoRadiusByMember

@Nullable
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.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:

key - must not be null.

member - must not be null.

radius -

Returns:

never null unless used in pipeline / transaction.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

@Nullable
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                                                                                               M member,
                                                                                                                                               org.springframework.data.geo.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.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRadiusByMember

@Nullable
org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoRadiusByMember(K key,
                                                                                                                                               M member,
                                                                                                                                               org.springframework.data.geo.Distance distance,
                                                                                                                                               org.springframework.data.redis.connection.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.

See Also:

Redis Documentation: GEORADIUSBYMEMBER

geoRemove

@Nullable
Long geoRemove(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.