Class GeohashReferenceSystem

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

ReferencingByIdentifiers

GeohashReferenceSystem

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, 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

Modifier and Type	Field	Description
static final String	OVERALL_OWNER_KEY	Key for the "overall­Owner" property to be given to the object factory create­Foo(…) methods.
static final String	THEME_KEY	Key for the "theme" property to be given to the object factory create­Foo(…) methods.

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the object factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the object factory create­Foo(…) methods.

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

equals, format­To, get­Location­Types, get­Overall­Owner, get­Theme

Modifier and Type	Method	Description
boolean	equals(Object object, Comparison­Mode mode)	Compares this reference system with the specified object for equality.
protected String	format­To(Formatter formatter)	Formats a pseudo-Well Known Text (WKT) representation for this object.
List<? extends Modifiable­Location­Type>	get­Location­Types()	Description of location type(s) in the spatial reference system.
Abstract­Party	get­Overall­Owner()	Authority with overall responsibility for the spatial reference system.
International­String	get­Theme()	Property used to characterize the spatial reference system.

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope, get­Standard­Type

Modifier and Type	Method	Description
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.

Methods inherited from class AbstractIdentifiedObject

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

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

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.