org.apache.sis.index

Class GeoHashCoder

Object

GeoHashCoder

All Implemented Interfaces:

Serializable

Deprecated.

Moved to Geohash­Reference­System. Note that axis order of encode(double, double) method differs.

@Deprecated
public class GeoHashCoder
extends Object
implements Serializable

Encodes geographic coordinates as geohashes strings, and decode such strings back to coordinates. The current implementation is restricted to two-dimensional geographic coordinates, in the (longitude, latitude) order with the longitudes ranging from -180° to 180° and the latitudes ranging from -90° to 90°. The datum is unspecified.

Since:

0.1

See Also:

Wikipedia: Geohash, Serialized Form

Defined in the sis-storage module

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoHashCoder.Format Deprecated. Moved to Geohash­Reference­System.Format.

Constructor Summary

Constructors

Constructor and Description
GeoHashCoder() Deprecated. Creates a new geohash coder/decoder initialized to the default precision for Geo­Hash­Coder.Format.BASE32.

Method Summary

Modifier and Type	Method and Description
DirectPosition	decode(String geohash) Deprecated. Decodes the given geohash into a longitude and a latitude.
String	encode(DirectPosition position) Deprecated. Encodes the given position into a geohash.
String	encode(double longitude, double latitude) Deprecated. Encodes the given longitude and latitude into a geohash.
GeoHashCoder.Format	getFormat() Deprecated. Returns the current encoding/decoding format.
int	getPrecision() Deprecated. Returns the length of geohashes strings to be encoded by the encode(Direct­Position) method.
void	setFormat(GeoHashCoder.Format format) Deprecated. Sets the encoding/decoding format.
void	setPrecision(int precision) Deprecated. Sets the length of geohashes strings to be encoded by the encode(Direct­Position) method.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Detail

GeoHashCoder

public GeoHashCoder()

Deprecated.

Creates a new geohash coder/decoder initialized to the default precision for Geo­Hash­Coder.Format.BASE32.

Method Detail

getFormat

public GeoHashCoder.Format getFormat()

Deprecated.

Returns the current encoding/decoding format. The default value is Geo­Hash­Coder.Format.BASE32.

Returns:

the current format.

setFormat

public void setFormat(GeoHashCoder.Format format)

Deprecated.

Sets the encoding/decoding format.

Parameters:

format - the new format.

getPrecision

public int getPrecision()

Deprecated.

Returns the length of geohashes strings to be encoded by the encode(Direct­Position) method. The default value is 12.

Returns:

the length of geohashes strings.

setPrecision

public void setPrecision(int precision)

Deprecated.

Sets the length of geohashes strings to be encoded by the encode(Direct­Position) method.

Parameters:

precision - the new length of geohashes strings.

encode

public String encode(double longitude,
                     double latitude)

Deprecated.

Encodes the given longitude and latitude into a geohash.

Parameters:

longitude - longitude to encode, as decimal degrees in the [-180 … 180]° range.

latitude - latitude to encode, as decimal degrees in the [-90 … 90]° range.

Returns:

Geohash encoding of the given longitude and latitude.

encode

public String encode(DirectPosition position)

Deprecated.

Encodes the given position into a geohash. The current implementation takes the first ordinate value as the longitude, the second ordinate value as the latitude, then delegates to encode(double, double).

The current implementation does not verify the Coordinate Reference System of the given position. However this may change in future SIS versions.

Parameters:

position - the coordinate to encode.

Returns:

Geohash encoding of the given position.

decode

public DirectPosition decode(String geohash)
                      throws ParseException

Deprecated.

Decodes the given geohash into a longitude and a latitude.

Parameters:

geohash - geohash string to decode.

Returns:

a new position with the longitude at ordinate 0 and latitude at ordinate 1.

Throws:

Parse­Exception - if an error occurred while parsing the given string.