Class GeohashReferenceSystem.Coder
Object
Coder
- Enclosing class:
GeohashReferenceSystem
Conversions between direct positions and geohashes. Each
Coder
instance can read codes
at arbitrary precision, but formats at the specified precision.
The same Coder
instance can be reused for reading or writing many geohashes.
Immutability and thread safety
This class is not thread-safe. A new instance must be created for each thread, or synchronization must be applied by the caller.- Since:
- 0.8
Defined in the sis-referencing-by-identifiers
module
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Coder()
Creates a new geohash coder/decoder initialized to the default precision. -
Method Summary
Modifier and TypeMethodDescriptiondecode
(CharSequence geohash) Decodes the given geohash into a latitude and a longitude.encode
(double φ, double λ) Encodes the given latitude and longitude into a geohash.encode
(DirectPosition position) Encodes the given position into a geohash.int
Returns the length of geohashes strings to be encoded by theencode(DirectPosition)
method.void
setHashLength
(int length) Sets the length of geohashes strings to be encoded by theencode(DirectPosition)
method.
-
Constructor Details
-
Coder
protected Coder()Creates a new geohash coder/decoder initialized to the default precision.
-
-
Method Details
-
getHashLength
public int getHashLength()Returns the length of geohashes strings to be encoded by theencode(DirectPosition)
method. The default value forGeohashReferenceSystem.Format.BASE32
is 12.- Returns:
- the length of geohashes strings.
-
setHashLength
public void setHashLength(int length) Sets the length of geohashes strings to be encoded by theencode(DirectPosition)
method.- Parameters:
length
- the new length of geohashes strings.
-
encode
Encodes the given latitude and longitude into a geohash. This method does not take in account the axis order and units of the coordinate reference system (CRS) given to theGeohashReferenceSystem
constructor. For geohashing of coordinates in different CRS, useencode(DirectPosition)
instead.- Parameters:
φ
- latitude to encode, as decimal degrees in the [-90 … 90]° range.λ
- longitude to encode, as decimal degrees in the [-180 … 180]° range.- Returns:
- geohash encoding of the given longitude and latitude.
- Throws:
TransformException
- if an error occurred while formatting the given coordinate.
-
encode
Encodes the given position into a geohash. The default implementation transforms the given position to the coordinate reference system expected by the enclosingGeohashReferenceSystem
, then delegates toencode(double, double)
.- Parameters:
position
- the coordinate to encode.- Returns:
- geohash encoding of the given position.
- Throws:
TransformException
- if an error occurred while transforming the given coordinate to a geohash reference.
-
decode
Decodes the given geohash into a latitude and a longitude. The axis order depends on the coordinate reference system of the enclosingGeohashReferenceSystem
.Upcoming API change — generalization
in a future SIS version, the type of returned element may be generalized to theorg.opengis.referencing.gazetteer.Location
interface. This change is pending GeoAPI revision.- Parameters:
geohash
- geohash string to decode.- Returns:
- a new geographic coordinate for the given geohash.
- Throws:
TransformException
- if an error occurred while parsing the given string.
-