io.github.privacystreams.location

Class GeolocationOperators

java.lang.Object

io.github.privacystreams.location.GeolocationOperators

@PSOperatorWrapper
public class GeolocationOperators
extends java.lang.Object

A helper class to access geolocation-related operators

Constructor Summary

Constructors

Constructor and Description
GeolocationOperators()

Method Summary

Modifier and Type	Method and Description
static Function<Item,java.lang.Double>	distanceBetween(java.lang.String latLonField1, java.lang.String latLonField2) Get the distance between two locations (in meters).
static Function<Item,LatLon>	distort(java.lang.String latLonField, double radius) Distort the coordinates value of a field and return the distorted coordinates.
static Function<Item,java.lang.Boolean>	inCircle(java.lang.String latLonField, double centerLat, double centerLng, double radius) Check if the coordinates specified by a LatLon field is a location in an given circular region.
static Function<Item,java.lang.Boolean>	inSquare(java.lang.String latLonField, double minLat, double minLng, double maxLat, double maxLng) Check if the coordinates specified by a LatLon field is a location in an given square region.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeolocationOperators

public GeolocationOperators()

Method Detail

inCircle

public static Function<Item,java.lang.Boolean> inCircle(java.lang.String latLonField,
                                                        double centerLat,
                                                        double centerLng,
                                                        double radius)

Check if the coordinates specified by a LatLon field is a location in an given circular region.

Parameters:

latLonField - the LatLon field to check

centerLat - latitude of the center of the area

centerLng - longitude of the center of the area

radius - radius of the region, in meters

Returns:

the function

inSquare

public static Function<Item,java.lang.Boolean> inSquare(java.lang.String latLonField,
                                                        double minLat,
                                                        double minLng,
                                                        double maxLat,
                                                        double maxLng)

Check if the coordinates specified by a LatLon field is a location in an given square region.

Parameters:

latLonField - the LatLon field to check

minLat - the minimum latitude of the region

minLng - the minimum longitude of the region

maxLat - the maximum latitude of the region

maxLng - the maximum longitude of the region

Returns:

the function

distort

public static Function<Item,LatLon> distort(java.lang.String latLonField,
                                            double radius)

Distort the coordinates value of a field and return the distorted coordinates. The distorted coordinates is an instance of `LatLon` class.

Parameters:

latLonField - the coordinates field to distort

radius - the distance to distort, in meters

Returns:

the function

distanceBetween

public static Function<Item,java.lang.Double> distanceBetween(java.lang.String latLonField1,
                                                              java.lang.String latLonField2)

Get the distance between two locations (in meters).

Parameters:

latLonField1 - the first location

latLonField2 - the second location

Returns:

the function