org.apache.lucene.spatial3d.geom

Class GeoCircleFactory

java.lang.Object

org.apache.lucene.spatial3d.geom.GeoCircleFactory

public class GeoCircleFactory
extends Object

Class which constructs a GeoCircle representing an arbitrary circle.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Method Summary

Modifier and Type	Method and Description
static GeoCircle	makeExactGeoCircle(PlanetModel planetModel, double latitude, double longitude, double radius, double accuracy) Create an exact GeoCircle given specified bounds and desired accuracy.
static GeoCircle	makeGeoCircle(PlanetModel planetModel, double latitude, double longitude, double radius) Create a GeoCircle of the right kind given the specified bounds.

Methods inherited from class java.lang.Object

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

Method Detail

makeGeoCircle

public static GeoCircle makeGeoCircle(PlanetModel planetModel,
                                      double latitude,
                                      double longitude,
                                      double radius)

Create a GeoCircle of the right kind given the specified bounds.

Parameters:

planetModel - is the planet model.

latitude - is the center latitude.

longitude - is the center longitude.

radius - is the radius angle.

Returns:

a GeoCircle corresponding to what was specified.

makeExactGeoCircle

public static GeoCircle makeExactGeoCircle(PlanetModel planetModel,
                                           double latitude,
                                           double longitude,
                                           double radius,
                                           double accuracy)

Create an exact GeoCircle given specified bounds and desired accuracy.

Parameters:

planetModel - is the planet model.

latitude - is the center latitude.

longitude - is the center longitude.

radius - is the radius surface distance.

accuracy - is the maximum linear distance between the circle approximation and the real circle, as computed using the Vincenty formula.

Returns:

a GeoCircle corresponding to what was specified.