Package org.redisson.api

Interface RGeoReactive<V>

Type Parameters:

V - type of value

All Superinterfaces:

RExpirableReactive, RObjectReactive, RScoredSortedSetReactive<V>, RSortableReactive<Set<V>>

public interface RGeoReactive<V>
extends RScoredSortedSetReactive<V>

Geospatial items holder. Reactive interface.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Long>	add(double longitude, double latitude, V member)	Adds geospatial member.
reactor.core.publisher.Mono<Long>	add(GeoEntry... entries)	Adds geospatial members.
reactor.core.publisher.Mono<Long>	addIfExists(double longitude, double latitude, V member)	Adds geospatial member only if it's already exists.
reactor.core.publisher.Mono<Long>	addIfExists(GeoEntry... entries)	Adds geospatial members only if it's already exists.
reactor.core.publisher.Mono<Double>	dist(V firstMember, V secondMember, GeoUnit geoUnit)	Returns distance between members in GeoUnit units.
reactor.core.publisher.Mono<Map<V,String>>	hash(V... members)	Returns 11 characters long Geohash string mapped by defined member.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	pos(V... members)	Returns geo-position mapped by defined member.
reactor.core.publisher.Mono<List<V>>	radius(double longitude, double latitude, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(V member, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(V member, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<List<V>>	radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Long>	radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(V member, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(V member, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<Map<V,Double>>	radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(V member, double radius, GeoUnit geoUnit)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(V member, double radius, GeoUnit geoUnit, int count)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)	Deprecated.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)	Deprecated.
reactor.core.publisher.Mono<List<V>>	search(GeoSearchArgs args)	Returns the members of a sorted set, which are within the borders of specified search conditions.
reactor.core.publisher.Mono<Map<V,Double>>	searchWithDistance(GeoSearchArgs args)	Returns the distance mapped by member of a sorted set, which are within the borders of specified search conditions.
reactor.core.publisher.Mono<Map<V,GeoPosition>>	searchWithPosition(GeoSearchArgs args)	Returns the position mapped by member of a sorted set, which are within the borders of specified search conditions.
reactor.core.publisher.Mono<Long>	storeSearchTo(String destName, GeoSearchArgs args)	Finds the members of a sorted set, which are within the borders of specified search conditions.
RFuture<Long>	storeSortedSearchTo(String destName, GeoSearchArgs args)	Finds the members of a sorted set, which are within the borders of specified search conditions.
reactor.core.publisher.Mono<Boolean>	tryAdd(double longitude, double latitude, V member)	Adds geospatial member only if has not been added before.
reactor.core.publisher.Mono<Long>	tryAdd(GeoEntry... entries)	Adds geospatial members only if has not been added before.

Methods inherited from interface org.redisson.api.RExpirableReactive

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectReactive

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RScoredSortedSetReactive

add, addAll, addAllIfAbsent, addAllIfExist, addAllIfGreater, addAllIfLess, addAndGetRank, addAndGetRevRank, addAndGetRevRank, addIfAbsent, addIfExists, addIfGreater, addIfLess, addScore, addScoreAndGetRank, addScoreAndGetRevRank, contains, containsAll, count, countIntersection, countIntersection, diff, entryRange, entryRange, entryRange, entryRangeReversed, entryRangeReversed, entryRangeReversed, first, firstScore, getScore, getScore, intersection, intersection, intersection, intersection, iterator, iterator, iterator, iterator, last, lastScore, pollFirst, pollFirst, pollFirst, pollFirst, pollFirstEntriesFromAny, pollFirstEntriesFromAny, pollFirstFromAny, pollFirstFromAny, pollFirstFromAny, pollLast, pollLast, pollLast, pollLast, pollLastEntriesFromAny, pollLastEntriesFromAny, pollLastFromAny, pollLastFromAny, pollLastFromAny, random, random, randomEntries, rangeTo, rangeTo, rangeTo, rank, readAll, readDiff, readIntersection, readIntersection, readIntersection, readIntersection, readUnion, readUnion, readUnion, readUnion, remove, removeAll, removeRangeByRank, removeRangeByScore, replace, retainAll, revRangeTo, revRangeTo, revRangeTo, revRank, revRank, size, takeFirst, takeFirstElements, takeLast, takeLastElements, tryAdd, union, union, union, union, valueRange, valueRange, valueRange, valueRangeReversed, valueRangeReversed, valueRangeReversed

Methods inherited from interface org.redisson.api.RSortableReactive

readSorted, readSorted, readSorted, readSorted, readSorted, readSorted, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo

Method Details

add

reactor.core.publisher.Mono<Long> add(double longitude,
 double latitude,
 V member)

Adds geospatial member.

Parameters:

longitude - - longitude of object

latitude - - latitude of object

member - - object itself

Returns:

number of elements added to the sorted set, not including elements already existing for which the score was updated

add

reactor.core.publisher.Mono<Long> add(GeoEntry... entries)

Adds geospatial members.

Parameters:

entries - - objects

Returns:

number of elements added to the sorted set, not including elements already existing for which the score was updated

addIfExists

reactor.core.publisher.Mono<Long> addIfExists(double longitude,
 double latitude,
 V member)

Adds geospatial member only if it's already exists.

Requires Redis 6.2.0 and higher.

Parameters:

longitude - - longitude of object

latitude - - latitude of object

member - - object itself

Returns:

number of elements added to the sorted set

addIfExists

reactor.core.publisher.Mono<Long> addIfExists(GeoEntry... entries)

Adds geospatial members only if it's already exists.

Requires Redis 6.2.0 and higher.

Parameters:

entries - - objects

Returns:

number of elements added to the sorted set

tryAdd

reactor.core.publisher.Mono<Boolean> tryAdd(double longitude,
 double latitude,
 V member)

Adds geospatial member only if has not been added before.

Requires Redis 6.2.0 and higher.

Parameters:

longitude - - longitude of object

latitude - - latitude of object

member - - object itself

Returns:

number of elements added to the sorted set

tryAdd

reactor.core.publisher.Mono<Long> tryAdd(GeoEntry... entries)

Adds geospatial members only if has not been added before.

Requires Redis 6.2.0 and higher.

Parameters:

entries - - objects

Returns:

number of elements added to the sorted set

dist

reactor.core.publisher.Mono<Double> dist(V firstMember,
 V secondMember,
 GeoUnit geoUnit)

Returns distance between members in GeoUnit units.

Parameters:

firstMember - - first object

secondMember - - second object

geoUnit - - geo unit

Returns:

distance

hash

reactor.core.publisher.Mono<Map<V,String>> hash(V... members)

Returns 11 characters long Geohash string mapped by defined member.

Parameters:

members - - objects

Returns:

hash mapped by object

pos

reactor.core.publisher.Mono<Map<V,GeoPosition>> pos(V... members)

Returns geo-position mapped by defined member.

Parameters:

members - - objects

Returns:

geo position mapped by object

search

reactor.core.publisher.Mono<List<V>> search(GeoSearchArgs args)

Returns the members of a sorted set, which are within the borders of specified search conditions.

Usage examples:

 List objects = geo.search(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)
                                 .order(GeoOrder.ASC)
                                 .count(1)));
 

 List objects = geo.search(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)));
 

Requires Redis 3.2.10 and higher.

Parameters:

args - - search conditions object

Returns:

list of memebers

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

searchWithDistance

reactor.core.publisher.Mono<Map<V,Double>> searchWithDistance(GeoSearchArgs args)

Returns the distance mapped by member of a sorted set, which are within the borders of specified search conditions.

Usage examples:

 Map objects = geo.searchWithDistance(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)
                                 .order(GeoOrder.ASC)
                                 .count(1)));
 

 Map objects = geo.searchWithDistance(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)));
 

Requires Redis 3.2.10 and higher.

Parameters:

args - - search conditions object

Returns:

distance mapped by object

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

searchWithPosition

reactor.core.publisher.Mono<Map<V,GeoPosition>> searchWithPosition(GeoSearchArgs args)

Returns the position mapped by member of a sorted set, which are within the borders of specified search conditions.

Usage examples:

 Map objects = geo.searchWithPosition(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)
                                 .order(GeoOrder.ASC)
                                 .count(1)));
 

 Map objects = geo.searchWithPosition(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)));
 

Requires Redis 3.2.10 and higher.

Parameters:

args - - search conditions object

Returns:

position mapped by object

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(V member,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(V member,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radius

@Deprecated
reactor.core.publisher.Mono<List<V>> radius(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(V member,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(V member,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radiusWithDistance

@Deprecated
reactor.core.publisher.Mono<Map<V,Double>> radiusWithDistance(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(V member,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(V member,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder)

Deprecated.

radiusWithPosition

@Deprecated
reactor.core.publisher.Mono<Map<V,GeoPosition>> radiusWithPosition(V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

storeSearchTo

reactor.core.publisher.Mono<Long> storeSearchTo(String destName,
 GeoSearchArgs args)

Finds the members of a sorted set, which are within the borders of specified search conditions.

Stores result to destName.

Usage examples:

 long count = geo.storeSearchTo(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)
                                 .order(GeoOrder.ASC)
                                 .count(1)));
 

 long count = geo.storeSearchTo(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)));
 

Parameters:

args - - search conditions object

Returns:

length of result

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusStoreTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

storeSortedSearchTo

RFuture<Long> storeSortedSearchTo(String destName,
 GeoSearchArgs args)

Finds the members of a sorted set, which are within the borders of specified search conditions.

Stores result to destName sorted by distance.

Usage examples:

 long count = geo.storeSortedSearchTo(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)
                                 .order(GeoOrder.ASC)
                                 .count(1)));
 

 long count = geo.storeSortedSearchTo(GeoSearchArgs.from(15, 37)
                                 .radius(200, GeoUnit.KILOMETERS)));
 

Parameters:

args - - search conditions object

Returns:

length of result

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 double longitude,
 double latitude,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit)

Deprecated.

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit,
 int count)

Deprecated.

radiusStoreSortedTo

@Deprecated
reactor.core.publisher.Mono<Long> radiusStoreSortedTo(String destName,
 V member,
 double radius,
 GeoUnit geoUnit,
 GeoOrder geoOrder,
 int count)

Deprecated.