org.elasticsearch.index.mapper

Class LegacyGeoPointFieldMapper.Encoding

java.lang.Object

org.elasticsearch.index.mapper.LegacyGeoPointFieldMapper.Encoding

Enclosing class:

LegacyGeoPointFieldMapper

public static final class LegacyGeoPointFieldMapper.Encoding
extends java.lang.Object

A byte-aligned fixed-length encoding for latitudes and longitudes.

Method Summary

Modifier and Type	Method and Description
GeoPoint	decode(byte[] in, int offset, GeoPoint out) Decode a geo point from a byte-array, reading numBytes() bytes.
GeoPoint	decode(long latBits, long lonBits, GeoPoint out) Decode a geo point from the bits of the encoded latitude and longitudes.
double	decodeCoordinate(long bits) Decode a sequence of bits into the original coordinate.
void	encode(double lat, double lon, byte[] out, int offset) Encode a geo point into a byte-array, over numBytes() bytes.
long	encodeCoordinate(double lat) Return the bits that encode a latitude/longitude.
int	numBitsPerCoordinate() The number of bits required to encode a single coordinate of a geo point.
int	numBytes() The number of bytes required to encode a single geo point.
static LegacyGeoPointFieldMapper.Encoding	of(DistanceUnit.Distance precision) Get an instance based on the expected precision.
static LegacyGeoPointFieldMapper.Encoding	of(int numBytesPerValue) Get an instance based on the number of bytes that has been used to encode values.
DistanceUnit.Distance	precision()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static LegacyGeoPointFieldMapper.Encoding of(int numBytesPerValue)

Get an instance based on the number of bytes that has been used to encode values.

of

public static LegacyGeoPointFieldMapper.Encoding of(DistanceUnit.Distance precision)

Get an instance based on the expected precision. Here are examples of the number of required bytes per value depending on the expected precision:

• 1km: 4 bytes
• 3m: 6 bytes
• 1m: 8 bytes
• 1cm: 8 bytes
• 1mm: 10 bytes

precision

public DistanceUnit.Distance precision()

numBytes

public int numBytes()

The number of bytes required to encode a single geo point.

numBitsPerCoordinate

public int numBitsPerCoordinate()

The number of bits required to encode a single coordinate of a geo point.

encodeCoordinate

public long encodeCoordinate(double lat)

Return the bits that encode a latitude/longitude.

decodeCoordinate

public double decodeCoordinate(long bits)

Decode a sequence of bits into the original coordinate.

encode

public void encode(double lat,
                   double lon,
                   byte[] out,
                   int offset)

Encode a geo point into a byte-array, over numBytes() bytes.

decode

public GeoPoint decode(byte[] in,
                       int offset,
                       GeoPoint out)

Decode a geo point from a byte-array, reading numBytes() bytes.

decode

public GeoPoint decode(long latBits,
                       long lonBits,
                       GeoPoint out)

Decode a geo point from the bits of the encoded latitude and longitudes.