org.redisson

Class RedissonGeo<V>

java.lang.Object

org.redisson.RedissonGeo<V>

All Implemented Interfaces:

RExpirable, RExpirableAsync, RGeo<V>, RGeoAsync<V>, RObject, RObjectAsync

public class RedissonGeo<V>
extends Object
implements RGeo<V>

Constructor Summary

Constructors

Constructor and Description
RedissonGeo(Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonGeo(CommandAsyncExecutor connectionManager, String name)

Method Summary

Methods

Modifier and Type	Method and Description
long	add(double longitude, double latitude, V member) Adds geospatial member.
long	add(GeoEntry... entries) Adds geospatial members.
io.netty.util.concurrent.Future<Long>	addAsync(double longitude, double latitude, V member) Adds geospatial member.
io.netty.util.concurrent.Future<Long>	addAsync(GeoEntry... entries) Adds geospatial members.
protected boolean	await(io.netty.util.concurrent.Future<?> future, long timeout, TimeUnit timeoutUnit)
boolean	clearExpire() Clear an expire timeout or expire date for object.
io.netty.util.concurrent.Future<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
boolean	delete() Deletes the object
io.netty.util.concurrent.Future<Boolean>	deleteAsync() Delete object in async mode
Double	dist(V firstMember, V secondMember, GeoUnit geoUnit) Returns distance between members in GeoUnit units.
io.netty.util.concurrent.Future<Double>	distAsync(V firstMember, V secondMember, GeoUnit geoUnit) Returns distance between members in GeoUnit units.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
io.netty.util.concurrent.Future<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
io.netty.util.concurrent.Future<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
io.netty.util.concurrent.Future<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
protected <V> V	get(io.netty.util.concurrent.Future<V> future)
String	getName() Returns name of object
Map<V,String>	hash(V... members) Returns 11 characters Geohash string mapped by defined member.
io.netty.util.concurrent.Future<Map<V,String>>	hashAsync(V... members) Returns 11 characters Geohash string mapped by defined member.
boolean	isExists() Check object existence
io.netty.util.concurrent.Future<Boolean>	isExistsAsync() Check object existence in async mode.
void	migrate(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance
io.netty.util.concurrent.Future<Void>	migrateAsync(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance in async mode
boolean	move(int database) Move object to another database
io.netty.util.concurrent.Future<Boolean>	moveAsync(int database) Move object to another database in async mode
protected <V> io.netty.util.concurrent.Promise<V>	newPromise()
protected <V> io.netty.util.concurrent.Future<V>	newSucceededFuture(V result)
Map<V,GeoPosition>	pos(V... members) Returns geo-position mapped by defined member.
io.netty.util.concurrent.Future<Map<V,GeoPosition>>	posAsync(V... members) Returns geo-position mapped by defined member.
List<V>	radius(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.
List<V>	radius(V member, double radius, GeoUnit geoUnit) Returns the members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.
io.netty.util.concurrent.Future<List<V>>	radiusAsync(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.
io.netty.util.concurrent.Future<List<V>>	radiusAsync(V member, double radius, GeoUnit geoUnit) Returns the members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.
Map<V,Double>	radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the distance mapped by member, distance between member and the location.
Map<V,Double>	radiusWithDistance(V member, double radius, GeoUnit geoUnit) Returns the distance mapped by member, distance between member and the defined member location.
io.netty.util.concurrent.Future<Map<V,Double>>	radiusWithDistanceAsync(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the distance mapped by member, distance between member and the location.
io.netty.util.concurrent.Future<Map<V,Double>>	radiusWithDistanceAsync(V member, double radius, GeoUnit geoUnit) Returns the distance mapped by member, distance between member and the defined member location.
Map<V,GeoPosition>	radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the geo-position mapped by member.
Map<V,GeoPosition>	radiusWithPosition(V member, double radius, GeoUnit geoUnit) Returns the geo-position mapped by member.
io.netty.util.concurrent.Future<Map<V,GeoPosition>>	radiusWithPositionAsync(double longitude, double latitude, double radius, GeoUnit geoUnit) Returns the geo-position mapped by member.
io.netty.util.concurrent.Future<Map<V,GeoPosition>>	radiusWithPositionAsync(V member, double radius, GeoUnit geoUnit) Returns the geo-position mapped by member.
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
io.netty.util.concurrent.Future<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
void	rename(String newName) Rename current object key to newName
io.netty.util.concurrent.Future<Void>	renameAsync(String newName) Rename current object key to newName in async mode
boolean	renamenx(String newName) Rename current object key to newName only if new key is not exists
io.netty.util.concurrent.Future<Boolean>	renamenxAsync(String newName) Rename current object key to newName in async mode only if new key is not exists

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.core.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.core.RObject

delete, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.core.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.core.RObjectAsync

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonGeo

public RedissonGeo(CommandAsyncExecutor connectionManager,
           String name)

RedissonGeo

public RedissonGeo(Codec codec,
           CommandAsyncExecutor connectionManager,
           String name)

Method Detail

addAsync

public io.netty.util.concurrent.Future<Long> addAsync(double longitude,
                                             double latitude,
                                             V member)

Description copied from interface: RGeoAsync

Adds geospatial member.

Specified by:

addAsync in interface RGeoAsync<V>

Returns:

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

add

public long add(double longitude,
       double latitude,
       V member)

Description copied from interface: RGeo

Adds geospatial member.

Specified by:

add in interface RGeo<V>

Returns:

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

add

public long add(GeoEntry... entries)

Description copied from interface: RGeo

Adds geospatial members.

Specified by:

add in interface RGeo<V>

Returns:

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

addAsync

public io.netty.util.concurrent.Future<Long> addAsync(GeoEntry... entries)

Description copied from interface: RGeoAsync

Adds geospatial members.

Specified by:

addAsync in interface RGeoAsync<V>

Returns:

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

dist

public Double dist(V firstMember,
          V secondMember,
          GeoUnit geoUnit)

Description copied from interface: RGeo

Returns distance between members in GeoUnit units.

Specified by:

dist in interface RGeo<V>

Returns:

See Also:

GeoUnit}

distAsync

public io.netty.util.concurrent.Future<Double> distAsync(V firstMember,
                                                V secondMember,
                                                GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns distance between members in GeoUnit units.

Specified by:

distAsync in interface RGeoAsync<V>

Returns:

See Also:

GeoUnit}

hash

public Map<V,String> hash(V... members)

Description copied from interface: RGeo

Returns 11 characters Geohash string mapped by defined member.

Specified by:

hash in interface RGeo<V>

Returns:

hashAsync

public io.netty.util.concurrent.Future<Map<V,String>> hashAsync(V... members)

Description copied from interface: RGeoAsync

Returns 11 characters Geohash string mapped by defined member.

Specified by:

hashAsync in interface RGeoAsync<V>

Returns:

pos

public Map<V,GeoPosition> pos(V... members)

Description copied from interface: RGeo

Returns geo-position mapped by defined member.

Specified by:

pos in interface RGeo<V>

Returns:

posAsync

public io.netty.util.concurrent.Future<Map<V,GeoPosition>> posAsync(V... members)

Description copied from interface: RGeoAsync

Returns geo-position mapped by defined member.

Specified by:

posAsync in interface RGeoAsync<V>

Returns:

radius

public List<V> radius(double longitude,
             double latitude,
             double radius,
             GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radius in interface RGeo<V>

Returns:

radiusAsync

public io.netty.util.concurrent.Future<List<V>> radiusAsync(double longitude,
                                                   double latitude,
                                                   double radius,
                                                   GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radiusAsync in interface RGeoAsync<V>

Returns:

radiusWithDistance

public Map<V,Double> radiusWithDistance(double longitude,
                               double latitude,
                               double radius,
                               GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the distance mapped by member, distance between member and the location. Members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radiusWithDistance in interface RGeo<V>

Returns:

radiusWithDistanceAsync

public io.netty.util.concurrent.Future<Map<V,Double>> radiusWithDistanceAsync(double longitude,
                                                                     double latitude,
                                                                     double radius,
                                                                     GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the distance mapped by member, distance between member and the location. Members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radiusWithDistanceAsync in interface RGeoAsync<V>

Returns:

radiusWithPosition

public Map<V,GeoPosition> radiusWithPosition(double longitude,
                                    double latitude,
                                    double radius,
                                    GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the geo-position mapped by member. Members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radiusWithPosition in interface RGeo<V>

Returns:

radiusWithPositionAsync

public io.netty.util.concurrent.Future<Map<V,GeoPosition>> radiusWithPositionAsync(double longitude,
                                                                          double latitude,
                                                                          double radius,
                                                                          GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the geo-position mapped by member. Members of a sorted set, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius) in GeoUnit units.

Specified by:

radiusWithPositionAsync in interface RGeoAsync<V>

Returns:

radius

public List<V> radius(V member,
             double radius,
             GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radius in interface RGeo<V>

Returns:

radiusAsync

public io.netty.util.concurrent.Future<List<V>> radiusAsync(V member,
                                                   double radius,
                                                   GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radiusAsync in interface RGeoAsync<V>

Returns:

radiusWithDistance

public Map<V,Double> radiusWithDistance(V member,
                               double radius,
                               GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the distance mapped by member, distance between member and the defined member location. Members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radiusWithDistance in interface RGeo<V>

Returns:

radiusWithDistanceAsync

public io.netty.util.concurrent.Future<Map<V,Double>> radiusWithDistanceAsync(V member,
                                                                     double radius,
                                                                     GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the distance mapped by member, distance between member and the defined member location. Members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radiusWithDistanceAsync in interface RGeoAsync<V>

Returns:

radiusWithPosition

public Map<V,GeoPosition> radiusWithPosition(V member,
                                    double radius,
                                    GeoUnit geoUnit)

Description copied from interface: RGeo

Returns the geo-position mapped by member. Members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radiusWithPosition in interface RGeo<V>

Returns:

radiusWithPositionAsync

public io.netty.util.concurrent.Future<Map<V,GeoPosition>> radiusWithPositionAsync(V member,
                                                                          double radius,
                                                                          GeoUnit geoUnit)

Description copied from interface: RGeoAsync

Returns the geo-position mapped by member. Members of a sorted set, which are within the borders of the area specified with the defined member location and the maximum distance from the defined member location (the radius) in GeoUnit units.

Specified by:

radiusWithPositionAsync in interface RGeoAsync<V>

Returns:

expire

public boolean expire(long timeToLive,
             TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public io.netty.util.concurrent.Future<Boolean> expireAsync(long timeToLive,
                                                   TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public io.netty.util.concurrent.Future<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public io.netty.util.concurrent.Future<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public io.netty.util.concurrent.Future<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public io.netty.util.concurrent.Future<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds

await

protected boolean await(io.netty.util.concurrent.Future<?> future,
            long timeout,
            TimeUnit timeoutUnit)
                 throws InterruptedException

Throws:

InterruptedException

get

protected <V> V get(io.netty.util.concurrent.Future<V> future)

newPromise

protected <V> io.netty.util.concurrent.Promise<V> newPromise()

newSucceededFuture

protected <V> io.netty.util.concurrent.Future<V> newSucceededFuture(V result)

getName

public String getName()

Description copied from interface: RObject

Returns name of object

Specified by:

getName in interface RObject

Returns:

name

rename

public void rename(String newName)

Description copied from interface: RObject

Rename current object key to newName

Specified by:

rename in interface RObject

renameAsync

public io.netty.util.concurrent.Future<Void> renameAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode

Specified by:

renameAsync in interface RObjectAsync

Returns:

migrate

public void migrate(String host,
           int port,
           int database)

Description copied from interface: RObject

Transfer an object from source Redis instance to destination Redis instance

Specified by:

migrate in interface RObject

Parameters:

host - - destination host

port - - destination port

database - - destination database

migrateAsync

public io.netty.util.concurrent.Future<Void> migrateAsync(String host,
                                                 int port,
                                                 int database)

Description copied from interface: RObjectAsync

Transfer an object from source Redis instance to destination Redis instance in async mode

Specified by:

migrateAsync in interface RObjectAsync

Parameters:

host - - destination host

port - - destination port

database - - destination database

Returns:

move

public boolean move(int database)

Description copied from interface: RObject

Move object to another database

Specified by:

move in interface RObject

Returns:

true if key was moved else false

moveAsync

public io.netty.util.concurrent.Future<Boolean> moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Returns:

true if key was moved false if not

renamenx

public boolean renamenx(String newName)

Description copied from interface: RObject

Rename current object key to newName only if new key is not exists

Specified by:

renamenx in interface RObject

Returns:

renamenxAsync

public io.netty.util.concurrent.Future<Boolean> renamenxAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode only if new key is not exists

Specified by:

renamenxAsync in interface RObjectAsync

Returns:

delete

public boolean delete()

Description copied from interface: RObject

Deletes the object

Specified by:

delete in interface RObject

deleteAsync

public io.netty.util.concurrent.Future<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Returns:

true if object was deleted false if not

isExists

public boolean isExists()

Description copied from interface: RObject

Check object existence

Specified by:

isExists in interface RObject

Returns:

true if object exists and false otherwise

isExistsAsync

public io.netty.util.concurrent.Future<Boolean> isExistsAsync()

Description copied from interface: RObjectAsync

Check object existence in async mode.

Specified by:

isExistsAsync in interface RObjectAsync

Returns:

true if object exists and false otherwise