GeoHash (Groovy Documentation)

geoscript.index.GeoHash

```
class GeoHash
extends java.lang.Object
```
A GeoHash module. This is a port of node-geohash (https://github.com/sunng87/node-geohash).
Authors:
Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static enum`	`GeoHash.Direction`	A Direction enum used when calculating neighbors

Constructor Summary

Constructors
Constructor and description
`GeoHash()` Create a new GeoHash

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.List<java.lang.String>`	`bboxes(Bounds bounds)` Calculate all of the hash strings in a Bounds
	`java.util.List<java.lang.String>`	`bboxes(Bounds bounds, int numberOfChars)` Calculate all of the hash strings in a Bounds
	`java.util.List<java.lang.Long>`	`bboxesLong(Bounds bounds)` Calculate all of the hash longs in a Bounds
	`java.util.List<java.lang.Long>`	`bboxesLong(Bounds bounds, int bitDepth)` Calculate all of the hash longs in a Bounds
	`Point`	`decode(java.lang.String hashString)` Decode a Point from the hash string
	`Point`	`decode(long hashLong)` Decode a Point from a hash long
	`Bounds`	`decodeBounds(java.lang.String hashString)` Decode a Bounds from a hash string
	`Bounds`	`decodeBounds(long hashLong)` Decode a Bounds from a hash long using 52 as the bit depth
	`Bounds`	`decodeBounds(long hashLong, int bitDepth)` Decode a Bounds from as hash long
	`java.lang.String`	`encode(Point pt)` Encode a Point as a hash string that is 9 characters long
	`java.lang.String`	`encode(Point pt, boolean autoEncode)` Encode a Point as a hash string
	`java.lang.String`	`encode(Point pt, int numberOfChars)` Encode a Point as a hash string
	`long`	`encodeLong(Point pt)` Encode a Point as a hash long using 52 as the bit depth
	`long`	`encodeLong(Point pt, int bitDepth)` Encode a Point as a hash long
	`java.lang.String`	`neighbor(java.lang.String hashString, GeoHash.Direction direction)` Calculate the neighbor of a hash string for the given direction
	`java.lang.String`	`neighbor(java.lang.String hashString, GeoHash.Direction direction, int numberOfChars)` Calculate the neighbor of a hash string for the given direction
	`java.lang.String`	`neighbor(java.lang.String hashString, int lonStep, int latStep, int numberOfChars)` Calculate the neighbor of a hash string with a number of steps in the latitude and longitude directions.
	`long`	`neighbor(long hashLong, GeoHash.Direction direction)` Calculate the neighbor of a hash long in the given Direction
	`long`	`neighbor(long hashLong, GeoHash.Direction direction, int bitDepth)` Calculate the neighbor of a hash long in the given Direction
	`long`	`neighbor(long hashLong, int lonStep, int latStep, int bitDepth)` Calculate the neighbor of a hash long with a number of steps in the latitude and longitude directions.
	`java.util.Map<Direction, java.lang.String>`	`neighbors(java.lang.String hashString)` Calculate all of the surrounding neighbors of the given hash string
	`java.util.Map<Direction, java.lang.String>`	`neighbors(java.lang.String hashString, int numberOfChar)` Calculate all of the surrounding neighbors of the given hash string
	`java.util.Map<Direction, java.lang.Long>`	`neighbors(long hashLong)` Calculate all of the surrounding neighbors of the given hash long
	`java.util.Map<Direction, java.lang.Long>`	`neighbors(long hashLong, int bitDepth)` Calculate all of the surrounding neighbors of the given hash long

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - GeoHash()
    
    Create a new GeoHash
- Method Detail
  - java.util.List<java.lang.String> bboxes(Bounds bounds)
    
    Calculate all of the hash strings in a Bounds
    Parameters:
    bounds - The Bounds
    Returns:
    A List of hash strings
  - java.util.List<java.lang.String> bboxes(Bounds bounds, int numberOfChars)
    
    Calculate all of the hash strings in a Bounds
    Parameters:
    bounds - The Bounds
    numberOfChars - The number of characters to use while encoding
    Returns:
    A List of hash strings
  - java.util.List<java.lang.Long> bboxesLong(Bounds bounds)
    
    Calculate all of the hash longs in a Bounds
    Parameters:
    bounds - The Bounds
    Returns:
    A List of hash longs
  - java.util.List<java.lang.Long> bboxesLong(Bounds bounds, int bitDepth)
    
    Calculate all of the hash longs in a Bounds
    params:
    bitDepth The bit depth to use while encoding
    
    Parameters:
    bounds - The Bounds
    Returns:
    A List of hash longs
  - Point decode(java.lang.String hashString)
    
    Decode a Point from the hash string
    Parameters:
    hashString - The hash string
    Returns:
    A Point
  - Point decode(long hashLong)
    
    Decode a Point from a hash long
    Parameters:
    hashLong - The hash long
    Returns:
    A Point
  - Bounds decodeBounds(java.lang.String hashString)
    
    Decode a Bounds from a hash string
    Parameters:
    hashString - The hash string
    Returns:
    A Bounds
  - Bounds decodeBounds(long hashLong)
    
    Decode a Bounds from a hash long using 52 as the bit depth
    Parameters:
    hashLong - The hash long
    Returns:
    A Bounds
  - Bounds decodeBounds(long hashLong, int bitDepth)
    
    Decode a Bounds from as hash long
    Parameters:
    hashLong - The hash long
    bitDepth - The bit depth
    Returns:
    A Bounds
  - java.lang.String encode(Point pt)
    
    Encode a Point as a hash string that is 9 characters long
    Parameters:
    pt - The Point
    Returns:
    A hash string
  - java.lang.String encode(Point pt, boolean autoEncode)
    
    Encode a Point as a hash string
    Parameters:
    pt - The Point
    autoEncode - Whether to auto encode or not. If false, encode using 9 characters, else calculate the number of characters.
    Returns:
    A hash string
  - java.lang.String encode(Point pt, int numberOfChars)
    
    Encode a Point as a hash string
    Parameters:
    pt - The Point
    numberOfChars - The number of characters
    Returns:
    A hash string
  - long encodeLong(Point pt)
    
    Encode a Point as a hash long using 52 as the bit depth
    Parameters:
    pt - The Point
    Returns:
    A hash long
  - long encodeLong(Point pt, int bitDepth)
    
    Encode a Point as a hash long
    Parameters:
    pt - The Point
    bitDepth - The bit depth
    Returns:
    A hash long
  - java.lang.String neighbor(java.lang.String hashString, GeoHash.Direction direction)
    
    Calculate the neighbor of a hash string for the given direction
    Parameters:
    hashString - The hash string
    direction - The Direction
    Returns:
    A hash string
  - java.lang.String neighbor(java.lang.String hashString, GeoHash.Direction direction, int numberOfChars)
    
    Calculate the neighbor of a hash string for the given direction
    Parameters:
    hashString - The hash string
    direction - The Direction
    numberOfChars - The number of characters to use while encoding
    Returns:
    A hash string
  - java.lang.String neighbor(java.lang.String hashString, int lonStep, int latStep, int numberOfChars)
    
    Calculate the neighbor of a hash string with a number of steps in the latitude and longitude directions.
    Parameters:
    hashString - The hash string
    lonStep - The number of steps along the longitude axis
    latStep - The number of steps along the latitude axis
    numberOfChars - The number of characters to use while encoding
    Returns:
    A hash string
  - long neighbor(long hashLong, GeoHash.Direction direction)
    
    Calculate the neighbor of a hash long in the given Direction
    Parameters:
    hashLong - The hash long
    direction - The Direction
    Returns:
    A hash long
  - long neighbor(long hashLong, GeoHash.Direction direction, int bitDepth)
    
    Calculate the neighbor of a hash long in the given Direction
    Parameters:
    hashLong - The hash long
    direction - The Direction
    bitDepth - The bit depth to use while encoding
    Returns:
    A hash long
  - long neighbor(long hashLong, int lonStep, int latStep, int bitDepth)
    
    Calculate the neighbor of a hash long with a number of steps in the latitude and longitude directions.
    Parameters:
    hashLong - The hash long
    lonStep - The number of steps along the longitude axis
    latStep - The number of steps along the latitude axis
    bitDepth - The bit depth to use while encoding
    Returns:
    A hash long
  - java.util.Map<Direction, java.lang.String> neighbors(java.lang.String hashString)
    
    Calculate all of the surrounding neighbors of the given hash string
    Parameters:
    hashString - The hash string
    Returns:
    A Map of Directions with hash strings
  - java.util.Map<Direction, java.lang.String> neighbors(java.lang.String hashString, int numberOfChar)
    
    Calculate all of the surrounding neighbors of the given hash string
    Parameters:
    hashString - The hash string
    numberOfChar - The number of characters to use while encoding
    Returns:
    A Map of Directions with hash strings
  - java.util.Map<Direction, java.lang.Long> neighbors(long hashLong)
    
    Calculate all of the surrounding neighbors of the given hash long
    Parameters:
    hashLong - The hash long
    Returns:
    A Map of Directions with hash strings
  - java.util.Map<Direction, java.lang.Long> neighbors(long hashLong, int bitDepth)
    
    Calculate all of the surrounding neighbors of the given hash long
    Parameters:
    hashLong - The hash long
    bitDepth - The bit depth to use while encoding
    Returns:
    A Map of Directions with hash strings

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class GeoHash

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

GeoHash()

Method Detail

java.util.List<java.lang.String> bboxes(Bounds bounds)

java.util.List<java.lang.String> bboxes(Bounds bounds, int numberOfChars)

java.util.List<java.lang.Long> bboxesLong(Bounds bounds)

java.util.List<java.lang.Long> bboxesLong(Bounds bounds, int bitDepth)

Point decode(java.lang.String hashString)

Point decode(long hashLong)

Bounds decodeBounds(java.lang.String hashString)

Bounds decodeBounds(long hashLong)

Bounds decodeBounds(long hashLong, int bitDepth)

java.lang.String encode(Point pt)

java.lang.String encode(Point pt, boolean autoEncode)

java.lang.String encode(Point pt, int numberOfChars)

long encodeLong(Point pt)

long encodeLong(Point pt, int bitDepth)

java.lang.String neighbor(java.lang.String hashString, GeoHash.Direction direction)

java.lang.String neighbor(java.lang.String hashString, GeoHash.Direction direction, int numberOfChars)

java.lang.String neighbor(java.lang.String hashString, int lonStep, int latStep, int numberOfChars)

long neighbor(long hashLong, GeoHash.Direction direction)

long neighbor(long hashLong, GeoHash.Direction direction, int bitDepth)

long neighbor(long hashLong, int lonStep, int latStep, int bitDepth)

java.util.Map<Direction, java.lang.String> neighbors(java.lang.String hashString)

java.util.Map<Direction, java.lang.String> neighbors(java.lang.String hashString, int numberOfChar)

java.util.Map<Direction, java.lang.Long> neighbors(long hashLong)

java.util.Map<Direction, java.lang.Long> neighbors(long hashLong, int bitDepth)