org.elasticsearch.common.geo

列挙型 GeoDistance

java.lang.Object

java.lang.Enum<GeoDistance>

org.elasticsearch.common.geo.GeoDistance

すべての実装されたインタフェース:

Serializable, Comparable<GeoDistance>

public enum GeoDistance
extends Enum<GeoDistance>

Geo distance calculation.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	GeoDistance.ArcFixedSourceDistance
static interface	GeoDistance.DistanceBoundingCheck
static class	GeoDistance.FactorFixedSourceDistance
static interface	GeoDistance.FixedSourceDistance
static class	GeoDistance.FixedSourceDistanceBase Basic implementation of GeoDistance.FixedSourceDistance.
static class	GeoDistance.Meridian180DistanceBoundingCheck
static class	GeoDistance.PlaneFixedSourceDistance
static class	GeoDistance.SimpleDistanceBoundingCheck
static class	GeoDistance.SloppyArcFixedSourceDistance

列挙型定数のサマリー

列挙型定数

列挙型定数と説明
ARC Calculates distance as points on a globe.
FACTOR Calculates distance factor.
PLANE Calculates distance as points on a plane.
SLOPPY_ARC Calculates distance as points on a globe in a sloppy way.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static org.elasticsearch.common.geo.GeoDistance.AlwaysDistanceBoundingCheck	ALWAYS_INSTANCE
static GeoDistance	DEFAULT Default GeoDistance function.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract double	calculate(double sourceLatitude, double sourceLongitude, double targetLatitude, double targetLongitude, DistanceUnit unit)
static GeoDistance.DistanceBoundingCheck	distanceBoundingCheck(double sourceLatitude, double sourceLongitude, double distance, DistanceUnit unit)
static SortedNumericDoubleValues	distanceValues(MultiGeoPointValues geoPointValues, GeoDistance.FixedSourceDistance... distances) Return a SortedNumericDoubleValues instance that returns the distances to a list of geo-points for each document.
abstract GeoDistance.FixedSourceDistance	fixedSourceDistance(double sourceLatitude, double sourceLongitude, DistanceUnit unit)
static GeoDistance	fromString(String name) Get a GeoDistance according to a given name.
abstract double	normalize(double distance, DistanceUnit unit)
static GeoDistance	valueOf(String name) 指定した名前を持つこの型の列挙型定数を返します。
static GeoDistance[]	values() この列挙型の定数を含む配列を宣言されている順序で返します。

クラスから継承されたメソッド java.lang.Enum

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

クラスから継承されたメソッド java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

列挙型定数の詳細

PLANE

public static final GeoDistance PLANE

Calculates distance as points on a plane. Faster, but less accurate than ARC.

FACTOR

public static final GeoDistance FACTOR

Calculates distance factor.

ARC

public static final GeoDistance ARC

Calculates distance as points on a globe.

SLOPPY_ARC

public static final GeoDistance SLOPPY_ARC

Calculates distance as points on a globe in a sloppy way. Close to the pole areas the accuracy of this function decreases.

フィールドの詳細

DEFAULT

public static final GeoDistance DEFAULT

Default GeoDistance function. This method should be used, If no specific function has been selected. This is an alias for SLOPPY_ARC

ALWAYS_INSTANCE

public static final org.elasticsearch.common.geo.GeoDistance.AlwaysDistanceBoundingCheck ALWAYS_INSTANCE

メソッドの詳細

values

public static GeoDistance[] values()

この列挙型の定数を含む配列を宣言されている順序で返します。 このメソッドは次のようにして定数を反復するために 使用できます:

for(GeoDistance c: GeoDistance.values())
  System.out.println(c);

戻り値:

この列挙型の定数を含む、宣言されている順序での配列

valueOf

public static GeoDistance valueOf(String name)

指定した名前を持つこの型の列挙型定数を返します。 文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。 (余分な空白文字を含めることはできません。)

パラメータ:

name - 返される列挙型定数の名前。

戻り値:

指定した名前の列挙型定数

例外:

IllegalArgumentException - この列挙型に、指定した名前の定数がない場合

NullPointerException - 引数がnullの場合

normalize

public abstract double normalize(double distance,
                                 DistanceUnit unit)

calculate

public abstract double calculate(double sourceLatitude,
                                 double sourceLongitude,
                                 double targetLatitude,
                                 double targetLongitude,
                                 DistanceUnit unit)

fixedSourceDistance

public abstract GeoDistance.FixedSourceDistance fixedSourceDistance(double sourceLatitude,
                                                                    double sourceLongitude,
                                                                    DistanceUnit unit)

distanceBoundingCheck

public static GeoDistance.DistanceBoundingCheck distanceBoundingCheck(double sourceLatitude,
                                                                      double sourceLongitude,
                                                                      double distance,
                                                                      DistanceUnit unit)

fromString

public static GeoDistance fromString(String name)

Get a GeoDistance according to a given name. Valid values are

• plane for GeoDistance.PLANE
• sloppy_arc for GeoDistance.SLOPPY_ARC
• factor for GeoDistance.FACTOR
• arc for GeoDistance.ARC

パラメータ:

name - name of the GeoDistance

戻り値:

a GeoDistance

distanceValues

public static SortedNumericDoubleValues distanceValues(MultiGeoPointValues geoPointValues,
                                                       GeoDistance.FixedSourceDistance... distances)

Return a SortedNumericDoubleValues instance that returns the distances to a list of geo-points for each document.