org.apache.sis.referencing.gazetteer

Class GeohashReferenceSystem

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

ReferencingByIdentifiers

GeohashReferenceSystem

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, IdentifiedObject, ReferenceSystem

public class GeohashReferenceSystem
extends ReferencingByIdentifiers

Geographic coordinates represented as geohashes strings.

Since:

0.8

See Also:

Geohash on Wikipedia, Serialized Form

Defined in the sis-referencing-by-identifiers module

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GeohashReferenceSystem.Coder Conversions between direct positions and geohashes.
static class	GeohashReferenceSystem.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 ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor and Description
GeohashReferenceSystem(GeohashReferenceSystem.Format format, GeographicCRS crs) Creates a new geohash reference system for the given format and coordinate reference system.

Method Summary

Modifier and Type	Method and Description
GeohashReferenceSystem.Coder	createCoder() Returns a new object performing conversions between Direct­Position and geohashes.
GeohashReferenceSystem.Format	getFormat() 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, get­Alias, get­Description, 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 Detail

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 can not be created.

Method Detail

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.

Returns:

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