Enum Class GeoDistance

java.lang.Object
java.lang.Enum<GeoDistance>
org.elasticsearch.common.geo.GeoDistance
All Implemented Interfaces:
Serializable, Comparable<GeoDistance>, Constable, Writeable

public enum GeoDistance extends Enum<GeoDistance> implements Writeable
Geo distance calculation.
  • Enum Constant Details

  • Method Details

    • values

      public static GeoDistance[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static GeoDistance valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • readFromStream

      public static GeoDistance readFromStream(StreamInput in) throws IOException
      Creates a GeoDistance instance from an input stream
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Writes an instance of a GeoDistance object to an output stream
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • fromString

      public static GeoDistance fromString(String name)
      Get a GeoDistance according to a given name. Valid values are
      • plane for GeoDistance.PLANE
      • arc for GeoDistance.ARC
      Parameters:
      name - name of the GeoDistance
      Returns:
      a GeoDistance
    • calculate

      public double calculate(double srcLat, double srcLon, double dstLat, double dstLon, DistanceUnit unit)
      compute the distance between two points using the selected algorithm (PLANE, ARC)