org.elasticsearch.common.geo

Enum GeoDistance

java.lang.Object

java.lang.Enum<GeoDistance>

org.elasticsearch.common.geo.GeoDistance

All Implemented Interfaces:

Serializable, Comparable<GeoDistance>

public enum GeoDistance
extends Enum<GeoDistance>

Geo distance calculation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoDistance.ArcFixedSourceDistance
static interface	GeoDistance.DistanceBoundingCheck
static class	GeoDistance.FactorFixedSourceDistance
static interface	GeoDistance.FixedSourceDistance
static class	GeoDistance.FixedSourceDistanceBase Basic implementation of GeoDistance.FixedSourceDistance.
static class	GeoDistance.Meridian180DistanceBoundingCheck
static class	GeoDistance.PlaneFixedSourceDistance
static class	GeoDistance.SimpleDistanceBoundingCheck
static class	GeoDistance.SloppyArcFixedSourceDistance

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARC Calculates distance as points on a globe.
FACTOR Calculates distance factor.
PLANE Calculates distance as points on a plane.
SLOPPY_ARC Calculates distance as points on a globe in a sloppy way.

Field Summary

Fields

Modifier and Type	Field and Description
static org.elasticsearch.common.geo.GeoDistance.AlwaysDistanceBoundingCheck	ALWAYS_INSTANCE
static GeoDistance	DEFAULT Default GeoDistance function.

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	calculate(double sourceLatitude, double sourceLongitude, double targetLatitude, double targetLongitude, DistanceUnit unit)
static GeoDistance.DistanceBoundingCheck	distanceBoundingCheck(double sourceLatitude, double sourceLongitude, double distance, DistanceUnit unit)
static SortedNumericDoubleValues	distanceValues(MultiGeoPointValues geoPointValues, GeoDistance.FixedSourceDistance... distances) Return a SortedNumericDoubleValues instance that returns the distances to a list of geo-points for each document.
abstract GeoDistance.FixedSourceDistance	fixedSourceDistance(double sourceLatitude, double sourceLongitude, DistanceUnit unit)
static GeoDistance	fromString(String name) Get a GeoDistance according to a given name.
abstract double	normalize(double distance, DistanceUnit unit)
static GeoDistance	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeoDistance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLANE

public static final GeoDistance PLANE

Calculates distance as points on a plane. Faster, but less accurate than ARC.

FACTOR

public static final GeoDistance FACTOR

Calculates distance factor.

ARC

public static final GeoDistance ARC

Calculates distance as points on a globe.

SLOPPY_ARC

public static final GeoDistance SLOPPY_ARC

Calculates distance as points on a globe in a sloppy way. Close to the pole areas the accuracy of this function decreases.

Field Detail

DEFAULT

public static final GeoDistance DEFAULT

Default GeoDistance function. This method should be used, If no specific function has been selected. This is an alias for SLOPPY_ARC

ALWAYS_INSTANCE

public static final org.elasticsearch.common.geo.GeoDistance.AlwaysDistanceBoundingCheck ALWAYS_INSTANCE

Method Detail

values

public static GeoDistance[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GeoDistance c : GeoDistance.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GeoDistance valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

normalize

public abstract double normalize(double distance,
               DistanceUnit unit)

calculate

public abstract double calculate(double sourceLatitude,
               double sourceLongitude,
               double targetLatitude,
               double targetLongitude,
               DistanceUnit unit)

fixedSourceDistance

public abstract GeoDistance.FixedSourceDistance fixedSourceDistance(double sourceLatitude,
                                                  double sourceLongitude,
                                                  DistanceUnit unit)

distanceBoundingCheck

public static GeoDistance.DistanceBoundingCheck distanceBoundingCheck(double sourceLatitude,
                                                      double sourceLongitude,
                                                      double distance,
                                                      DistanceUnit unit)

fromString

public static GeoDistance fromString(String name)

Get a GeoDistance according to a given name. Valid values are

• plane for GeoDistance.PLANE
• sloppy_arc for GeoDistance.SLOPPY_ARC
• factor for GeoDistance.FACTOR
• arc for GeoDistance.ARC

Parameters:

name - name of the GeoDistance

Returns:

a GeoDistance

distanceValues

public static SortedNumericDoubleValues distanceValues(MultiGeoPointValues geoPointValues,
                                       GeoDistance.FixedSourceDistance... distances)

Return a SortedNumericDoubleValues instance that returns the distances to a list of geo-points for each document.