Interface RGeo<V>

    • Method Detail

      • add

        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

        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

        Boolean 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

        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

        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

        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

        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

        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

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

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

        @Deprecated
        List<V> radius(double longitude,
                       double latitude,
                       double radius,
                       GeoUnit geoUnit,
                       int count)
        Deprecated.
      • searchWithDistance

        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:

         List objects = geo.searchWithDistance(GeoSearchArgs.from(15, 37)
                                         .radius(200, GeoUnit.KILOMETERS)
                                         .order(GeoOrder.ASC)
                                         .count(1)));
         
         List 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
        Map<V,Double> radiusWithDistance(double longitude,
                                               double latitude,
                                               double radius,
                                               GeoUnit geoUnit)
        Deprecated.
      • radiusWithDistance

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

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

        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:

         List objects = geo.searchWithPosition(GeoSearchArgs.from(15, 37)
                                         .radius(200, GeoUnit.KILOMETERS)
                                         .order(GeoOrder.ASC)
                                         .count(1)));
         
         List 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
        Map<V,GeoPosition> radiusWithPosition(double longitude,
                                                    double latitude,
                                                    double radius,
                                                    GeoUnit geoUnit,
                                                    int count)
        Deprecated.
      • storeSearchTo

        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
        long radiusStoreTo(String destName,
                           double longitude,
                           double latitude,
                           double radius,
                           GeoUnit geoUnit)
        Deprecated.
      • radiusStoreTo

        @Deprecated
        long radiusStoreTo(String destName,
                           double longitude,
                           double latitude,
                           double radius,
                           GeoUnit geoUnit,
                           int count)
        Deprecated.
      • radiusStoreTo

        @Deprecated
        long radiusStoreTo(String destName,
                           double longitude,
                           double latitude,
                           double radius,
                           GeoUnit geoUnit,
                           GeoOrder geoOrder,
                           int count)
        Deprecated.
      • radiusStoreTo

        @Deprecated
        long radiusStoreTo(String destName,
                           V member,
                           double radius,
                           GeoUnit geoUnit,
                           int count)
        Deprecated.
      • storeSortedSearchTo

        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
        long radiusStoreSortedTo(String destName,
                                 double longitude,
                                 double latitude,
                                 double radius,
                                 GeoUnit geoUnit)
        Deprecated.
      • radiusStoreSortedTo

        @Deprecated
        long radiusStoreSortedTo(String destName,
                                 double longitude,
                                 double latitude,
                                 double radius,
                                 GeoUnit geoUnit,
                                 int count)
        Deprecated.
      • radiusStoreSortedTo

        @Deprecated
        long radiusStoreSortedTo(String destName,
                                 double longitude,
                                 double latitude,
                                 double radius,
                                 GeoUnit geoUnit,
                                 GeoOrder geoOrder,
                                 int count)
        Deprecated.
      • radiusStoreSortedTo

        @Deprecated
        long radiusStoreSortedTo(String destName,
                                 V member,
                                 double radius,
                                 GeoUnit geoUnit)
        Deprecated.
      • radiusStoreSortedTo

        @Deprecated
        long radiusStoreSortedTo(String destName,
                                 V member,
                                 double radius,
                                 GeoUnit geoUnit,
                                 int count)
        Deprecated.
      • radiusStoreSortedTo

        @Deprecated
        long radiusStoreSortedTo(String destName,
                                 V member,
                                 double radius,
                                 GeoUnit geoUnit,
                                 GeoOrder geoOrder,
                                 int count)
        Deprecated.