Package org.redisson.api.geo

Class GeoSearchParams

java.lang.Object
org.redisson.api.geo.GeoSearchParams
All Implemented Interfaces:
GeoSearchArgs, OptionalGeoSearch, ShapeGeoSearch
public final class GeoSearchParams extends Object implements ShapeGeoSearch, OptionalGeoSearch
Author:
Nikita Koksharov

  • Method Details

    • box

      public OptionalGeoSearch box(double width, double height, GeoUnit geoUnit)
      Description copied from interface: ShapeGeoSearch
      Defines search within box

      Requires Redis 6.2.0 and higher.

      Specified by:
      box in interface ShapeGeoSearch
      Parameters:
      width - - box width
      height - - box height
      geoUnit - - geo unit
      Returns:
      search conditions object

    • radius

      public OptionalGeoSearch radius(double radius, GeoUnit geoUnit)
      Description copied from interface: ShapeGeoSearch
      Defines search within radius
      Specified by:
      radius in interface ShapeGeoSearch
      Parameters:
      radius - - radius in geo units
      geoUnit - - geo unit
      Returns:
      search conditions object

    • count

      public OptionalGeoSearch count(int value)
      Description copied from interface: OptionalGeoSearch
      Defines limit of search result
      Specified by:
      count in interface OptionalGeoSearch
      Parameters:
      value - - result limit
      Returns:
      search conditions object

    • countAny

      public OptionalGeoSearch countAny(int value)
      Description copied from interface: OptionalGeoSearch
      Defines limit of search result. Returns as soon as enough matches are found. Result size might be not closest to defined limit, but works faster.
      Specified by:
      countAny in interface OptionalGeoSearch
      Parameters:
      value - - result limit
      Returns:
      search conditions object

    • order

      public OptionalGeoSearch order(GeoOrder value)
      Description copied from interface: OptionalGeoSearch
      Defines order of search result
      Specified by:
      order in interface OptionalGeoSearch
      Parameters:
      value - - result order
      Returns:
      search conditions object

    • getMember

      public Object getMember()

    • getLongitude

      public Double getLongitude()

    • getLatitude

      public Double getLatitude()

    • getWidth

      public Double getWidth()

    • getHeight

      public Double getHeight()

    • getRadius

      public Double getRadius()

    • getUnit

      public GeoUnit getUnit()

    • getCount

      public Integer getCount()

    • isCountAny

      public boolean isCountAny()

    • getOrder

      public GeoOrder getOrder()