Module org.apache.sis.referencing.gazetteer

Package org.apache.sis.referencing.gazetteer

Class GeohashReferenceSystem

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

ReferencingByIdentifiers

GeohashReferenceSystem

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Identified­Object, Reference­System

public class GeohashReferenceSystem
extends ReferencingByIdentifiers

Geographic coordinates represented as geohashes strings. Geohash is a simple encoding of geographic coordinates into a short string of letters and digits. Longer strings are more accurate, however the accuracy is not uniformly distributed between latitude and longitude, and removing digits decreases accuracy faster when the point is located close to the equator than close to a pole. For a system having more uniform accuracy, see the Military Grid Reference System (MGRS).

Since:

0.8

See Also:

• Geohash on Wikipedia
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Geohash­Reference­System.Coder	Conversions between direct positions and geohashes.
static enum	Geohash­Reference­System.Format	The encoding format used by Geohash­Reference­System.Coder.

Field Summary

Fields inherited from class ReferencingByIdentifiers

OVERALL_OWNER_KEY, THEME_KEY

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Constructor Summary

Constructors

Constructor	Description
Geohash­Reference­System(Geohash­Reference­System.Format format, Geographic­CRS crs)	Creates a new geohash reference system for the given format and coordinate reference system.

Method Summary

Modifier and Type	Method	Description
Geohash­Reference­System.Coder	create­Coder()	Returns a new object performing conversions between Direct­Position and geohashes.
Geohash­Reference­System.Format	get­Format()	Returns the encoding/decoding format.

Methods inherited from class ReferencingByIdentifiers

compute­Hash­Code, equals, format­To, get­Location­Types, get­Overall­Owner, get­Theme

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Interface, get­Scope

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Details

GeohashReferenceSystem

public GeohashReferenceSystem(GeohashReferenceSystem.Format format,
 GeographicCRS crs)
                       throws GazetteerException

Creates a new geohash reference system for the given format and coordinate reference system.

Parameters:

format - the format used by the Geohash­Reference­System.Coder.

crs - the coordinate reference system. This is usually Common­CRS.default­Geographic().

Throws:

Gazetteer­Exception - if the reference system cannot be created.

Method Details

getFormat

public GeohashReferenceSystem.Format getFormat()

Returns the encoding/decoding format.

Returns:

the encoding/decoding format.

createCoder

public GeohashReferenceSystem.Coder createCoder()

Returns a new object performing conversions between Direct­Position and geohashes. The returned object is not thread-safe; a new instance must be created for each thread, or synchronization must be applied by the caller.

Specified by:

create­Coder in class Referencing­By­Identifiers

Returns:

a new object performing conversions between Direct­Position and geohashes.