Package io.vertigo.datafactory.plugins.search.elasticsearch

Enum Class ESDistanceUnit

java.lang.Object
java.lang.Enum<ESDistanceUnit>
io.vertigo.datafactory.plugins.search.elasticsearch.ESDistanceUnit
All Implemented Interfaces:
Serializable, Comparable<ESDistanceUnit>, Constable
public enum ESDistanceUnit extends Enum<ESDistanceUnit>
The ESDistanceUnit enumerates several units for measuring distances. These units provide methods for converting strings and methods to convert units among each others. Some methods like
invalid reference 
ESDistanceUnit#getEarthCircumference
refer to the earth ellipsoid defined in GeoUtils. The default unit used within this project is METERS which is defined by DEFAULT

  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static ESDistanceUnit[] 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 ESDistanceUnit 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

    • toMeters

      public double toMeters(double distance)
      Convert a value into meters
      Parameters:
      distance - distance in this unit
      Returns:
      value in meters

    • fromMeters

      public double fromMeters(double distance)
      Convert a value given in meters to a value of this unit
      Parameters:
      distance - distance in meters
      Returns:
      value in this unit

    • convert

      public double convert(double distance, ESDistanceUnit unit)
      Convert a given value into another unit
      Parameters:
      distance - value in this unit
      unit - source unit
      Returns:
      value in this unit

    • toString

      public String toString(double distance)
      Convert a value to a distance string
      Parameters:
      distance - value to convert
      Returns:
      String representation of the distance

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ESDistanceUnit>

    • convert

      public static double convert(double distance, ESDistanceUnit from, ESDistanceUnit to)
      Converts the given distance from the given ESDistanceUnit, to the given ESDistanceUnit
      Parameters:
      distance - Distance to convert
      from - Unit to convert the distance from
      to - Unit of distance to convert to
      Returns:
      Given distance converted to the distance in the given unit

    • parse

      public static double parse(String distance, ESDistanceUnit defaultUnit, ESDistanceUnit to)
      Parses a given distance and converts it to the specified unit.
      Parameters:
      distance - String defining a distance (value and unit)
      defaultUnit - unit assumed if none is defined
      to - unit of result
      Returns:
      parsed distance

    • parse

      public double parse(String distance, ESDistanceUnit defaultUnit)
      Parses a given distance and converts it to this unit.
      Parameters:
      distance - String defining a distance (value and unit)
      defaultUnit - unit to expect if none if provided
      Returns:
      parsed distance

    • fromString

      public static ESDistanceUnit fromString(String unit)
      Convert a String to a ESDistanceUnit
      Parameters:
      unit - name of the unit
      Returns:
      unit matching the given name
      Throws:
      IllegalArgumentException - if no unit matches the given name

    • parseUnit

      public static ESDistanceUnit parseUnit(String distance, ESDistanceUnit defaultUnit)
      Parses the suffix of a given distance string and return the corresponding ESDistanceUnit
      Parameters:
      distance - string representing a distance
      defaultUnit - default unit to use, if no unit is provided by the string
      Returns:
      unit of the given distance