Interface BoundGeoOperations<K,M>

All Superinterfaces:

BoundKeyOperations<K>

@NullUnmarked
public interface BoundGeoOperations<K,M>
extends BoundKeyOperations<K>

GeoOperations bound to a certain key.

Since:

1.8

Author:

Ninad Divadkar, Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
Long	add(@NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<M>> locations)	Add RedisGeoCommands.GeoLocations to key
Long	add(@NonNull Map<@NonNull M, @NonNull Point> memberCoordinateMap)	Add Map of member / Point pairs to key.
Long	add(@NonNull Point point, @NonNull M member)	Add Point with given member name to key.
Long	add(@NonNull RedisGeoCommands.GeoLocation<M> location)	Add RedisGeoCommands.GeoLocation to key.
Distance	distance(@NonNull M member1, @NonNull M member2)	Get the Distance between member1 and member2.
Distance	distance(@NonNull M member1, @NonNull M member2, @NonNull Metric metric)	Get the Distance between member1 and member2 in the given Metric.
RedisOperations<K,?>	getOperations()
List<String>	hash(@NonNull M @NonNull ... members)	Get Geohash representation of the position for one or more members.
List<Point>	position(@NonNull M @NonNull ... members)	Get the Point representation of positions for one or more members.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(@NonNull M member, double radius)	Get the members within the circle defined by the members coordinates and given radius.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(@NonNull M member, @NonNull Distance distance)	Get the members within the circle defined by the members coordinates and given radius applying Metric.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(@NonNull M member, @NonNull Distance distance, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the circle defined by the members coordinates and given radius applying Metric and RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(@NonNull Circle within)	Get the members within the boundaries of a given Circle.
GeoResults<RedisGeoCommands.GeoLocation<M>>	radius(@NonNull Circle within, @NonNull RedisGeoCommands.GeoRadiusCommandArgs args)	Get the members within the boundaries of a given Circle applying RedisGeoCommands.GeoRadiusCommandArgs.
Long	remove(@NonNull M @NonNull ... members)	Remove the members.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull Circle within)	Get the members within the boundaries of a given Circle.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull GeoReference<M> reference, @NonNull Distance radius)	Get the members using GeoReference as center of the query within the boundaries of a given radius.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull GeoReference<M> reference, @NonNull Distance radius, @NonNull RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull GeoReference<M> reference, @NonNull BoundingBox boundingBox)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box.
default GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull GeoReference<M> reference, @NonNull BoundingBox boundingBox, @NonNull RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.
GeoResults<RedisGeoCommands.GeoLocation<M>>	search(@NonNull GeoReference<M> reference, @NonNull GeoShape geoPredicate, @NonNull RedisGeoCommands.GeoSearchCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.
default Long	searchAndStore(@NonNull K destKey, @NonNull Circle within)	Get the members within the boundaries of a given Circle and store results at destKey.
default Long	searchAndStore(@NonNull K destKey, @NonNull GeoReference<M> reference, @NonNull Distance radius)	Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.
default Long	searchAndStore(@NonNull K destKey, @NonNull GeoReference<M> reference, @NonNull Distance radius, @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
default Long	searchAndStore(@NonNull K destKey, @NonNull GeoReference<M> reference, @NonNull BoundingBox boundingBox)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.
default Long	searchAndStore(@NonNull K destKey, @NonNull GeoReference<M> reference, @NonNull BoundingBox boundingBox, RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.
Long	searchAndStore(@NonNull K destKey, @NonNull GeoReference<M> reference, @NonNull GeoShape geoPredicate, @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)	Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Methods inherited from interface BoundKeyOperations

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

Method Details

add

Long add(@NonNull Point point,
 @NonNull 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. null when used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEOADD

add

Long add(@NonNull RedisGeoCommands.GeoLocation<M> location)

Add RedisGeoCommands.GeoLocation to key.

Parameters:

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

Long add(@NonNull Map<@NonNull M, @NonNull Point> memberCoordinateMap)

Add Map of member / Point pairs to key.

Parameters:

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

Long add(@NonNull Iterable<@NonNull RedisGeoCommands.GeoLocation<M>> locations)

Add RedisGeoCommands.GeoLocations to key

Parameters:

locations - must not be null.

Returns:

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

Since:

2.0

See Also:

• Redis Documentation: GEOADD

distance

Distance distance(@NonNull M member1,
 @NonNull M member2)

Get the Distance between member1 and member2.

Parameters:

member1 - must not be null.

member2 - must not be null.

Returns:

can be null.

Since:

2.0

See Also:

• Redis Documentation: GEODIST

distance

Distance distance(@NonNull M member1,
 @NonNull M member2,
 @NonNull 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.

Since:

2.0

See Also:

• Redis Documentation: GEODIST

hash

List<String> hash(@NonNull M @NonNull ... members)

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

Parameters:

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEOHASH

position

List<Point> position(@NonNull M @NonNull ... members)

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

Parameters:

members - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEOPOS

radius

GeoResults<RedisGeoCommands.GeoLocation<M>> radius(@NonNull Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEORADIUS

radius

GeoResults<RedisGeoCommands.GeoLocation<M>> radius(@NonNull Circle within,
 @NonNull 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 unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEORADIUS

radius

GeoResults<RedisGeoCommands.GeoLocation<M>> radius(@NonNull 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 unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

radius

GeoResults<RedisGeoCommands.GeoLocation<M>> radius(@NonNull M member,
 @NonNull 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 unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

radius

GeoResults<RedisGeoCommands.GeoLocation<M>> radius(@NonNull M member,
 @NonNull Distance distance,
 @NonNull 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 unless used in pipeline / transaction.

Since:

2.0

See Also:

• Redis Documentation: GEORADIUSBYMEMBER

remove

Long remove(@NonNull M @NonNull ... members)

Remove the members.

Parameters:

members - must not be null.

Returns:

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

Since:

2.0

search

default GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull Circle within)

Get the members within the boundaries of a given Circle.

Parameters:

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull GeoReference<M> reference,
 @NonNull Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius.

Parameters:

reference - must not be null.

radius - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull GeoReference<M> reference,
 @NonNull Distance radius,
 @NonNull RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull GeoReference<M> reference,
 @NonNull BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box.

Parameters:

reference - must not be null.

boundingBox - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

default GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull GeoReference<M> reference,
 @NonNull BoundingBox boundingBox,
 @NonNull RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

search

GeoResults<RedisGeoCommands.GeoLocation<M>> search(@NonNull GeoReference<M> reference,
 @NonNull GeoShape geoPredicate,
 @NonNull RedisGeoCommands.GeoSearchCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs.

Parameters:

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCH

searchAndStore

default Long searchAndStore(@NonNull K destKey,
 @NonNull Circle within)

Get the members within the boundaries of a given Circle and store results at destKey.

Parameters:

within - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Long searchAndStore(@NonNull K destKey,
 @NonNull GeoReference<M> reference,
 @NonNull Distance radius)

Get the members using GeoReference as center of the query within the boundaries of a given radius and store results at destKey.

Parameters:

reference - must not be null.

radius - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Long searchAndStore(@NonNull K destKey,
 @NonNull GeoReference<M> reference,
 @NonNull Distance radius,
 @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given radius applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

radius - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Long searchAndStore(@NonNull K destKey,
 @NonNull GeoReference<M> reference,
 @NonNull BoundingBox boundingBox)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box and store results at destKey.

Parameters:

reference - must not be null.

boundingBox - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

default Long searchAndStore(@NonNull K destKey,
 @NonNull GeoReference<M> reference,
 @NonNull BoundingBox boundingBox,
 RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given bounding box applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

boundingBox - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

searchAndStore

Long searchAndStore(@NonNull K destKey,
 @NonNull GeoReference<M> reference,
 @NonNull GeoShape geoPredicate,
 @NonNull RedisGeoCommands.GeoSearchStoreCommandArgs args)

Get the members using GeoReference as center of the query within the boundaries of a given predicate applying RedisGeoCommands.GeoRadiusCommandArgs and store results at destKey.

Parameters:

reference - must not be null.

geoPredicate - must not be null.

args - must not be null.

Returns:

never null unless used in pipeline / transaction.

Since:

2.6

See Also:

• Redis Documentation: GEOSEARCHSTORE

getOperations

RedisOperations<K,?> getOperations()

Specified by:

getOperations in interface BoundKeyOperations<K>

Returns:

the underlying RedisOperations used to execute commands.

Since:

4.0