Package org.elasticsearch.common.geo

Enum Class GeoDistance

<GeoDistance>
org.elasticsearch.common.geo.GeoDistance
All Implemented Interfaces:
, <, Writeable
public enum GeoDistance extends <GeoDistance> implements Writeable
Geo distance calculation.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARC
     
    PLANE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    calculate​(double srcLat, double srcLon, double dstLat, double dstLon, DistanceUnit unit)
    compute the distance between two points using the selected algorithm (PLANE, ARC)
    static GeoDistance
     name)
    Get a GeoDistance according to a given name.
    static GeoDistance
    readFromStream​(StreamInput in)
    Creates a GeoDistance instance from an input stream
    static GeoDistance
     name)
    Returns the enum constant of this class with the specified name.
    static GeoDistance[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    void
    writeTo​(StreamOutput out)
    Writes an instance of a GeoDistance object to an output stream

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • 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  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:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • readFromStream

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

    • writeTo

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

    • fromString

      public static  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)