- All Superinterfaces:
BoundKeyOperations<K>
- Since:
- 1.8
- Author:
- Ninad Divadkar, Christoph Strobl, Mark Paluch
-
Method Summary
add(Map<M,org.springframework.data.geo.Point> memberCoordinateMap)
Add
Map
of member /
Point
pairs to key.
add(org.springframework.data.geo.Point point,
M member)
Add Point
with given member name to key.
org.springframework.data.geo.Distance
Get the Distance
between member1 and member2.
org.springframework.data.geo.Distance
distance(M member1,
M member2,
org.springframework.data.geo.Metric metric)
Get the Distance
between member1 and member2 in the given Metric
.
Get Geohash representation of the position for one or more members.
List<org.springframework.data.geo.Point>
Get the Point
representation of positions for one or more members.
Get the members within the circle defined by the members coordinates and given
radius.
radius(M member,
org.springframework.data.geo.Distance distance)
Get the members within the circle defined by the members coordinates and given
radius applying Metric
.
radius(org.springframework.data.geo.Circle within)
Get the members within the boundaries of a given Circle
.
search(org.springframework.data.geo.Circle within)
Get the members within the boundaries of a given Circle
.
Get the members using
GeoReference
as center of the query within the boundaries of a given
radius
.
Get the members using
GeoReference
as center of the query within the boundaries of a given
bounding box.
Get the members within the boundaries of a given Circle
and store results at destKey
.
Get the members using
GeoReference
as center of the query within the boundaries of a given
radius
and store results at
destKey
.
Get the members using
GeoReference
as center of the query within the boundaries of a given
bounding box and store results at
destKey
.
-
Method Details
-
add
@Nullable
Long add(org.springframework.data.geo.Point point,
M member)
Add Point
with given member name to key.
- Parameters:
point
- must not be null.
member
- must not be null.
- Returns:
- Number of elements added. null when used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
add
- Parameters:
location
- must not be null.
- Returns:
- Number of elements added. null when used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
add
@Nullable
Long add(Map<M,org.springframework.data.geo.Point> memberCoordinateMap)
Add
Map
of member /
Point
pairs to key.
- Parameters:
memberCoordinateMap
- must not be null.
- Returns:
- Number of elements added. null when used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
add
- Parameters:
locations
- must not be null.
- Returns:
- Number of elements added. null when used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
distance
@Nullable
org.springframework.data.geo.Distance distance(M member1,
M member2)
Get the Distance
between member1 and member2.
- Parameters:
member1
- must not be null.
member2
- must not be null.
- Returns:
- can be null.
- Since:
- 2.0
- See Also:
-
-
distance
@Nullable
org.springframework.data.geo.Distance distance(M member1,
M member2,
org.springframework.data.geo.Metric metric)
Get the Distance
between member1 and member2 in the given Metric
.
- Parameters:
member1
- must not be null.
member2
- must not be null.
metric
- must not be null.
- Returns:
- can be null.
- Since:
- 2.0
- See Also:
-
-
hash
Get Geohash representation of the position for one or more members.
- Parameters:
members
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
position
@Nullable
List<org.springframework.data.geo.Point> position(M... members)
Get the Point
representation of positions for one or more members.
- Parameters:
members
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
radius
Get the members within the boundaries of a given Circle
.
- Parameters:
within
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
radius
- Parameters:
within
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
radius
Get the members within the circle defined by the members coordinates and given
radius.
- Parameters:
member
- must not be null.
radius
-
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
radius
Get the members within the circle defined by the members coordinates and given
radius applying Metric
.
- Parameters:
member
- must not be null.
distance
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
radius
- Parameters:
member
- must not be null.
distance
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.0
- See Also:
-
-
remove
@Nullable
Long remove(M... members)
Remove the members.
- Parameters:
members
- must not be null.
- Returns:
- Number of elements removed. null when used in pipeline / transaction.
- Since:
- 2.0
-
search
Get the members within the boundaries of a given Circle
.
- Parameters:
within
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
search
Get the members using
GeoReference
as center of the query within the boundaries of a given
radius
.
- Parameters:
reference
- must not be null.
radius
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
search
- Parameters:
reference
- must not be null.
radius
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
search
Get the members using
GeoReference
as center of the query within the boundaries of a given
bounding box.
- Parameters:
reference
- must not be null.
boundingBox
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
search
- Parameters:
reference
- must not be null.
boundingBox
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
search
- Parameters:
reference
- must not be null.
geoPredicate
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
@Nullable
default Long searchAndStore(K destKey,
org.springframework.data.geo.Circle within)
Get the members within the boundaries of a given Circle
and store results at destKey
.
- Parameters:
within
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
@Nullable
default Long searchAndStore(K destKey,
GeoReference<M> reference,
org.springframework.data.geo.Distance radius)
Get the members using
GeoReference
as center of the query within the boundaries of a given
radius
and store results at
destKey
.
- Parameters:
reference
- must not be null.
radius
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
- Parameters:
reference
- must not be null.
radius
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
Get the members using
GeoReference
as center of the query within the boundaries of a given
bounding box and store results at
destKey
.
- Parameters:
reference
- must not be null.
boundingBox
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
- Parameters:
reference
- must not be null.
boundingBox
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-
-
searchAndStore
- Parameters:
reference
- must not be null.
geoPredicate
- must not be null.
args
- must not be null.
- Returns:
- never null unless used in pipeline / transaction.
- Since:
- 2.6
- See Also:
-