Module lettuce.core

Package io.lettuce.core

Class GeoSearch

java.lang.Object

io.lettuce.core.GeoSearch

public final class GeoSearch
extends Object

Utility to create GeoSearch.GeoPredicate and GeoSearch.GeoRef objects to be used with GEOSEARCH.

Since:

6.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoSearch.GeoPredicate	Geo predicate specifying a search scope.
static interface	GeoSearch.GeoRef<K>	Geo reference specifying a search starting point.

Constructor Summary

Constructors

Constructor	Description
GeoSearch()

Method Summary

Modifier and Type	Method	Description
static GeoSearch.GeoPredicate	byBox(double width, double height, GeoArgs.Unit unit)	Create a GeoSearch.GeoPredicate by specifying a box of the size width, height and GeoArgs.Unit.
static GeoSearch.GeoPredicate	byRadius(double distance, GeoArgs.Unit unit)	Create a GeoSearch.GeoPredicate by specifying a radius distance and GeoArgs.Unit.
static <K> GeoSearch.GeoRef<K>	fromCoordinates(double longitude, double latitude)	Create a GeoSearch.GeoRef from WGS84 coordinates longitude and latitude.
static <K> GeoSearch.GeoRef<K>	fromMember(K member)	Create a GeoSearch.GeoRef from a Geo set member.

Methods inherited from class java.lang.Object

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

Constructor Details

GeoSearch

public GeoSearch()

Method Details

fromMember

public static <K> GeoSearch.GeoRef<K> fromMember(K member)

Create a GeoSearch.GeoRef from a Geo set member.

Parameters:

member - the Geo set member to use as search reference starting point.

Returns:

the GeoSearch.GeoRef.

fromCoordinates

public static <K> GeoSearch.GeoRef<K> fromCoordinates(double longitude,
double latitude)

Create a GeoSearch.GeoRef from WGS84 coordinates longitude and latitude.

Parameters:

longitude - the longitude coordinate according to WGS84.

latitude - the latitude coordinate according to WGS84.

Returns:

the GeoSearch.GeoRef.

byRadius

public static GeoSearch.GeoPredicate byRadius(double distance,
GeoArgs.Unit unit)

Create a GeoSearch.GeoPredicate by specifying a radius distance and GeoArgs.Unit.

Parameters:

distance - the radius.

unit - size unit.

Returns:

the GeoSearch.GeoPredicate for the specified radius.

byBox

public static GeoSearch.GeoPredicate byBox(double width,
double height,
GeoArgs.Unit unit)

Create a GeoSearch.GeoPredicate by specifying a box of the size width, height and GeoArgs.Unit.

Parameters:

width - box width.

height - box height.

unit - size unit.

Returns:

the GeoSearch.GeoPredicate for the specified box.