Interface RGeoRx<V>

Type Parameters:
V - type of value
All Superinterfaces:
RExpirableRx, RObjectRx, RScoredSortedSetRx<V>, RSortableRx<Set<V>>

public interface RGeoRx<V> extends RScoredSortedSetRx<V>
Geospatial items holder. Reactive interface.
Author:
Nikita Koksharov
  • Method Details

    • add

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<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

      io.reactivex.rxjava3.core.Single<Map<V,String>> hash(V... members)
      Returns 11 characters Geohash string mapped by defined member.
      Parameters:
      members - - objects
      Returns:
      hash mapped by object
    • pos

      io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> pos(V... members)
      Returns geo-position mapped by defined member.
      Parameters:
      members - - objects
      Returns:
      geo position mapped by object
    • search

      io.reactivex.rxjava3.core.Single<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 io.reactivex.rxjava3.core.Single<List<V>> radius(double longitude, double latitude, double radius, GeoUnit geoUnit)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • searchWithDistance

      io.reactivex.rxjava3.core.Single<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 io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • searchWithPosition

      io.reactivex.rxjava3.core.Single<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 io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(V member, double radius, GeoUnit geoUnit)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(V member, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radius

      @Deprecated io.reactivex.rxjava3.core.Single<List<V>> radius(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(V member, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(V member, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radiusWithDistance

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,Double>> radiusWithDistance(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(V member, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(V member, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder)
      Deprecated.
    • radiusWithPosition

      @Deprecated io.reactivex.rxjava3.core.Single<Map<V,GeoPosition>> radiusWithPosition(V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • storeSearchTo

      io.reactivex.rxjava3.core.Single<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 io.reactivex.rxjava3.core.Single<Long> radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusStoreTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusStoreTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • radiusStoreTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusStoreTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreTo(String destName, V member, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusStoreTo

      @Deprecated io.reactivex.rxjava3.core.Single<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 io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusStoreSortedTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusStoreSortedTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, double longitude, double latitude, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.
    • radiusStoreSortedTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit)
      Deprecated.
    • radiusStoreSortedTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, int count)
      Deprecated.
    • radiusStoreSortedTo

      @Deprecated io.reactivex.rxjava3.core.Single<Long> radiusStoreSortedTo(String destName, V member, double radius, GeoUnit geoUnit, GeoOrder geoOrder, int count)
      Deprecated.