org.elasticsearch.index.search.geo
Enum GeoDistance

java.lang.Object
  java.lang.Enum<GeoDistance>
      org.elasticsearch.index.search.geo.GeoDistance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GeoDistance>

public enum GeoDistance
extends java.lang.Enum<GeoDistance>

Geo distance calculation.

Enum Constant Summary

ARC
Calculates distance as points in a globe.

PLANE
Calculates distance as points on a plane.

Method Summary

abstract double	calculate(double sourceLatitude, double sourceLongitude, double targetLatitude, double targetLongitude, DistanceUnit unit)
static GeoDistance	fromString(java.lang.String s)
static GeoDistance	valueOf(java.lang.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.

ARC

public static final GeoDistance ARC

Calculates distance as points in a globe.

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

calculate

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

fromString

public static GeoDistance fromString(java.lang.String s)