Package org.elasticsearch.common.geo

Enum GeoDistance

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GeoDistance>, java.lang.constant.Constable, Writeable
    public enum GeoDistance
extends java.lang.Enum<GeoDistance>
implements Writeable
    Geo distance calculation.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    • 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 fromString​(java.lang.String name)
      Get a GeoDistance according to a given name.
      static GeoDistance readFromStream​(StreamInput in)
      Creates a GeoDistance instance from an input stream
      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.
      void writeTo​(StreamOutput out)
      Writes an instance of a GeoDistance object to an output stream

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static GeoDistance[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        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

      • readFromStream

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

      • writeTo

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

      • fromString

        public static GeoDistance fromString​(java.lang.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)