org.springframework.data.redis.core

Class DefaultGeoOperationsX<M>

java.lang.Object

org.springframework.data.redis.core.DefaultGeoOperationsX<M>

All Implemented Interfaces:

IKeyNamingPolicy, org.springframework.data.redis.core.GeoOperations<String,M>

public class DefaultGeoOperationsX<M>
extends Object
implements IKeyNamingPolicy

DefaultGeoOperationsX

Author:

Qicz

Constructor Summary

Constructors

Constructor and Description
DefaultGeoOperationsX(org.springframework.data.redis.core.RedisTemplate<String,M> template, IKeyNamingPolicy keyNamingPolicy) Creates new DefaultGeoOperations.

Method Summary

Modifier and Type	Method and Description
Long	add(String key, Iterable<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoLocations) Add RedisGeoCommands.GeoLocations to key
Long	add(String key, Map<M,org.springframework.data.geo.Point> memberCoordinateMap) Add Map of member / Point pairs to key.
Long	add(String key, org.springframework.data.geo.Point point, M member) Add Point with given member name to key.
Long	add(String key, org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M> location) Add RedisGeoCommands.GeoLocation to key.
org.springframework.data.geo.Distance	distance(String key, M member1, M member2) Get the Distance between member1 and member2.
org.springframework.data.geo.Distance	distance(String key, M member1, M member2, org.springframework.data.geo.Metric metric) Get the Distance between member1 and member2 in the given Metric.
String	getKeyName(String key) Get naming key
org.springframework.data.redis.core.RedisOperations<K,V>	getOperations()
List<String>	hash(String key, M... members) Get Geohash representation of the position for one or more members.
List<org.springframework.data.geo.Point>	position(String 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>>	radius(String 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>>	radius(String 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>>	radius(String 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>>	radius(String 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>>	radius(String key, M member, double radius) Get the members within the circle defined by the members coordinates and given radius.
Long	remove(String key, M... members) Remove the members.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openingo.spring.extension.data.redis.naming.IKeyNamingPolicy

getKeyNames, getKeyNames, mapKeyNaming

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

geoAdd, geoAdd, geoAdd, geoAdd, geoDist, geoDist, geoHash, geoPos, geoRadius, geoRadius, geoRadiusByMember, geoRadiusByMember, geoRadiusByMember, geoRemove

Constructor Detail

DefaultGeoOperationsX

public DefaultGeoOperationsX(org.springframework.data.redis.core.RedisTemplate<String,M> template,
                             IKeyNamingPolicy keyNamingPolicy)

Creates new DefaultGeoOperations.

Parameters:

template - must not be null.

keyNamingPolicy - key naming policy

Method Detail

add

public Long add(String key,
                org.springframework.data.geo.Point point,
                M member)

Add Point with given member name to key.

Specified by:

add in interface org.springframework.data.redis.core.GeoOperations<String,M>

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.

Since:

2.0

See Also:

Redis Documentation: GEOADD

add

public Long add(String key,
                org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Specified by:

add in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

location - must not be null.

Returns:

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

Since:

2.0

See Also:

Redis Documentation: GEOADD

add

public Long add(String key,
                Map<M,org.springframework.data.geo.Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Specified by:

add in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

memberCoordinateMap - must not be null.

Returns:

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

Since:

2.0

See Also:

Redis Documentation: GEOADD

add

public Long add(String key,
                Iterable<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> geoLocations)

Add RedisGeoCommands.GeoLocations to key

Specified by:

add in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

geoLocations - must not be null.

Returns:

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

Since:

2.0

See Also:

Redis Documentation: GEOADD

distance

public org.springframework.data.geo.Distance distance(String key,
                                                      M member1,
                                                      M member2)

Get the Distance between member1 and member2.

Specified by:

distance in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

Since:

2.0

See Also:

Redis Documentation: GEODIST

distance

public org.springframework.data.geo.Distance distance(String key,
                                                      M member1,
                                                      M member2,
                                                      org.springframework.data.geo.Metric metric)

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

Specified by:

distance in interface org.springframework.data.redis.core.GeoOperations<String,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.

Since:

2.0

See Also:

Redis Documentation: GEODIST

hash

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

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

Specified by:

hash in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOHASH

position

public List<org.springframework.data.geo.Point> position(String key,
                                                         M... members)

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

Specified by:

position in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEOPOS

radius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> radius(String key,
                                                                                                                                 org.springframework.data.geo.Circle within)

Get the members within the boundaries of a given Circle.

Specified by:

radius in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUS

radius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> radius(String 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.

Specified by:

radius in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

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

radius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> radius(String key,
                                                                                                                                 M member,
                                                                                                                                 double radius)

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

Specified by:

radius in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

member - must not be null.

radius -

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

Redis Documentation: GEORADIUSBYMEMBER

radius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> radius(String 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.

Specified by:

radius in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

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

radius

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<M>> radius(String 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.

Specified by:

radius in interface org.springframework.data.redis.core.GeoOperations<String,M>

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.

Since:

2.0

See Also:

Redis Documentation: GEORADIUSBYMEMBER

remove

public Long remove(String key,
                   M... members)

Remove the members.

Specified by:

remove in interface org.springframework.data.redis.core.GeoOperations<String,M>

Parameters:

key - must not be null.

members - must not be null.

Returns:

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

Since:

2.0

getKeyName

public String getKeyName(String key)

Description copied from interface: IKeyNamingPolicy

Get naming key

Specified by:

getKeyName in interface IKeyNamingPolicy

Returns:

naming key

getOperations

public org.springframework.data.redis.core.RedisOperations<K,V> getOperations()