Class Query.GeoRegion.Circle (2.0.0)

public static final class Query.GeoRegion.Circle extends Query.GeoRegion

A geographical region representing all points within a fixed distance from a central point, i.e., a circle. Intended for use in a geo-containment predicate filter.

Inheritance

java.lang.Object > Query.GeoRegion > Query.GeoRegion.Circle

Constructors

Circle(GeoPt center, double radius)

public Circle(GeoPt center, double radius)

Creates a new Circle object from the given arguments.

Parameters
Name Description
center GeoPt

a GeoPt representing the center of the circle
radius double

the radius of the circle, expressed in meters

Methods

contains(GeoPt point)

public boolean contains(GeoPt point)

Determines whether the given GeoPt value lies within this geographic region. If the point lies on the border of the region it is considered to be contained.

Parameter
Name Description
point GeoPt
Returns
Type Description
boolean
Overrides

equals(@Nullable Object o)

public boolean equals(@Nullable Object o)
Parameter
Name Description
o @org.checkerframework.checker.nullness.qual.Nullable java.lang.Object
Returns
Type Description
boolean
Overrides

getCenter()

public GeoPt getCenter()
Returns
Type Description
GeoPt

getRadius()

public double getRadius()
Returns
Type Description
double

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

toString()

public String toString()
Returns
Type Description
String
Overrides