org.elasticsearch.common.unit

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

org.elasticsearch.common.unit.DistanceUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceUnit>, Writeable

public enum DistanceUnit
extends java.lang.Enum<DistanceUnit>
implements Writeable

The DistanceUnit enumerates several units for measuring distances. These units provide methods for converting strings and methods to convert units among each others. Some methods like getEarthCircumference() refer to the earth ellipsoid defined in GeoUtils. The default unit used within this project is METERS which is defined by DEFAULT

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistanceUnit.Distance This class implements a value+unit tuple.

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 and Description
CENTIMETERS
FEET
INCH
KILOMETERS
METERS
MILES
MILLIMETERS
NAUTICALMILES
YARD

Field Summary

Fields

Modifier and Type	Field and Description
static DistanceUnit	DEFAULT

Method Summary

Modifier and Type	Method and Description
double	convert(double distance, DistanceUnit unit) Convert a given value into another unit
static double	convert(double distance, DistanceUnit from, DistanceUnit to) Converts the given distance from the given DistanceUnit, to the given DistanceUnit
double	fromMeters(double distance) Convert a value given in meters to a value of this unit
static DistanceUnit	fromString(java.lang.String unit) Convert a String to a DistanceUnit
double	getDistancePerDegree() Measures a longitude in this unit
double	getEarthCircumference() Measures the circumference of earth in this unit
double	getEarthRadius() Measures the radius of earth in this unit
double	parse(java.lang.String distance, DistanceUnit defaultUnit) Parses a given distance and converts it to this unit.
static double	parse(java.lang.String distance, DistanceUnit defaultUnit, DistanceUnit to) Parses a given distance and converts it to the specified unit.
static DistanceUnit	parseUnit(java.lang.String distance, DistanceUnit defaultUnit) Parses the suffix of a given distance string and return the corresponding DistanceUnit
static DistanceUnit	readFromStream(StreamInput in) Read a DistanceUnit from a StreamInput.
double	toMeters(double distance) Convert a value into meters
java.lang.String	toString()
java.lang.String	toString(double distance) Convert a value to a distance string
static DistanceUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DistanceUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out) Write a DistanceUnit to a StreamOutput.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCH

public static final DistanceUnit INCH

YARD

public static final DistanceUnit YARD

FEET

public static final DistanceUnit FEET

KILOMETERS

public static final DistanceUnit KILOMETERS

NAUTICALMILES

public static final DistanceUnit NAUTICALMILES

MILLIMETERS

public static final DistanceUnit MILLIMETERS

CENTIMETERS

public static final DistanceUnit CENTIMETERS

MILES

public static final DistanceUnit MILES

METERS

public static final DistanceUnit METERS

Field Detail

DEFAULT

public static final DistanceUnit DEFAULT

Method Detail

values

public static DistanceUnit[] 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 (DistanceUnit c : DistanceUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getEarthCircumference

public double getEarthCircumference()

Measures the circumference of earth in this unit

Returns:

length of earth circumference in this unit

getEarthRadius

public double getEarthRadius()

Measures the radius of earth in this unit

Returns:

length of earth radius in this unit

getDistancePerDegree

public double getDistancePerDegree()

Measures a longitude in this unit

Returns:

length of a longitude degree in this unit

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,
                      DistanceUnit unit)

Convert a given value into another unit

Parameters:

distance - value in this unit

unit - source unit

Returns:

value in this unit

toString

public java.lang.String toString(double distance)

Convert a value to a distance string

Parameters:

distance - value to convert

Returns:

String representation of the distance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DistanceUnit>

convert

public static double convert(double distance,
                             DistanceUnit from,
                             DistanceUnit to)

Converts the given distance from the given DistanceUnit, to the given DistanceUnit

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(java.lang.String distance,
                           DistanceUnit defaultUnit,
                           DistanceUnit 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(java.lang.String distance,
                    DistanceUnit 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 DistanceUnit fromString(java.lang.String unit)

Convert a String to a DistanceUnit

Parameters:

unit - name of the unit

Returns:

unit matching the given name

Throws:

java.lang.IllegalArgumentException - if no unit matches the given name

parseUnit

public static DistanceUnit parseUnit(java.lang.String distance,
                                     DistanceUnit defaultUnit)

Parses the suffix of a given distance string and return the corresponding DistanceUnit

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

readFromStream

public static DistanceUnit readFromStream(StreamInput in)
                                   throws java.io.IOException

Read a DistanceUnit from a StreamInput.

Parameters:

in - StreamInput to read the DistanceUnit from

Returns:

DistanceUnit read from the StreamInput

Throws:

java.io.IOException - if no unit can be read from the StreamInput

java.lang.IllegalArgumentException - if no matching DistanceUnit can be found

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Write a DistanceUnit to a StreamOutput.

Specified by:

writeTo in interface Writeable

Parameters:

out - StreamOutput to write to

Throws:

java.io.IOException