com.avos.avoscloud

Class AVGeoPoint

java.lang.Object

com.avos.avoscloud.AVGeoPoint

public class AVGeoPoint
extends Object

AVGeoPoint represents a latitude / longitude point that may be associated with a key in a AVObject or used as a reference point for geo queries. This allows proximity based queries on the key.

Only one key in a class may contain a GeoPoint.

Example:

 AVGeoPoint point = new AVGeoPoint(30.0, -20.0);
 AVObject object = new AVObject("PlaceObject");
 object.put("location", point);
 object.save();
 

Constructor Summary

Constructors

Constructor and Description
AVGeoPoint() Creates a new default point with latitude and longitude set to 0.0.
AVGeoPoint(double latitude, double longitude) Creates a new point with the specified latitude and longitude.

Method Summary

Modifier and Type	Method and Description
double	distanceInKilometersTo(AVGeoPoint point) Get distance between this point and another geopoint in kilometers.
double	distanceInMilesTo(AVGeoPoint point) Get distance between this point and another geopoint in miles.
double	distanceInRadiansTo(AVGeoPoint point) Get distance in radians between this point and another GeoPoint.
double	getLatitude() Get latitude.
double	getLongitude() Get longitude.
void	setLatitude(double l) Set latitude.
void	setLongitude(double l) Set longitude.

Methods inherited from class java.lang.Object

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

Constructor Detail

AVGeoPoint

public AVGeoPoint()

Creates a new default point with latitude and longitude set to 0.0.

AVGeoPoint

public AVGeoPoint(double latitude,
                  double longitude)

Creates a new point with the specified latitude and longitude.

Parameters:

latitude - The point's latitude.

longitude - The point's longitude.

Method Detail

distanceInKilometersTo

public double distanceInKilometersTo(AVGeoPoint point)

Get distance between this point and another geopoint in kilometers.

Parameters:

point - GeoPoint describing the other point being measured against.

Returns:

distance between two geo points

distanceInMilesTo

public double distanceInMilesTo(AVGeoPoint point)

Get distance between this point and another geopoint in miles.

Parameters:

point - GeoPoint describing the other point being measured against.

Returns:

distance between two geo points

distanceInRadiansTo

public double distanceInRadiansTo(AVGeoPoint point)

Get distance in radians between this point and another GeoPoint. This is the smallest angular distance between the two points.

Parameters:

point - GeoPoint describing the other point being measured against.

Returns:

distance between two geo points

getLatitude

public double getLatitude()

Get latitude.

Returns:

latitude

setLatitude

public void setLatitude(double l)

Set latitude. Valid range is (-90.0, 90.0). Extremes should not be used.

Parameters:

l - The point's latitude.

getLongitude

public double getLongitude()

Get longitude.

Returns:

longitude

setLongitude

public void setLongitude(double l)

Set longitude. Valid range is (-180.0, 180.0). Extremes should not be used.

Parameters:

l - The point's longitude.