de.alpharogroup.jgeohash

Class GeoHashExtensions

java.lang.Object

de.alpharogroup.jgeohash.GeoHashExtensions

public class GeoHashExtensions
extends Object

The class GeoHashExtensions. This class is based on http://en.wikipedia.org/wiki/Geohash.

Constructor Summary

Constructors

Constructor and Description
GeoHashExtensions()

Method Summary

Modifier and Type	Method and Description
static double[]	decode(String geohash) Decode the given geohash into a latitude and longitude.
static double[]	decodeAndRound(String geohash) Decodes the given geohash into a latitude and longitude.
static String	encode(double latitude, double longitude) Encodes the given latitude and longitude into a geohash code.
static String	getAdjacent(String geohash, String... directions) Gets the adjacent from the given directions.
static String	getAdjacent(String geohash, String direction) Gets the adjacent from the given direction.
static List<String>	getAllAdjacentAreasList(String geohash) Gets the all adjacent areas list.
static Map<String,String>	getAllAdjacentAreasMap(String geohash) Gets the geohash cells around the given geohash cell.
static FirstAndSecondRingRegion	getFirstAndSecondRingRegion(String geohash) Gets the geohash cells of the first and second ring region around the given geohash cell as a FirstAndSecondRingRegion object.
static FirstRingRegion	getFirstRingRegion(String geohash) Gets the geohash cells around the given geohash cell as a FirstRingRegion object.
static double	getLatitude(String geohash) Gets the latitude from the given geohash value.
static double	getLongitude(String geohash) Gets the longitude from the given geohash value.
static Map<String,String>	getTwentyFiveAreasMap(String geohash) Gets the eight cells around the given geohash cell so the first ring inclusive the given geohash cell and cells from the second ring.
static void	main(String[] args) The main method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoHashExtensions

public GeoHashExtensions()

Method Detail

decode

public static double[] decode(String geohash)

Decode the given geohash into a latitude and longitude.

Parameters:

geohash - the geohash

Returns:

the double[]

decodeAndRound

public static double[] decodeAndRound(String geohash)

Decodes the given geohash into a latitude and longitude.

Parameters:

geohash - the geohash

Returns:

the double[]

encode

public static String encode(double latitude,
                            double longitude)

Encodes the given latitude and longitude into a geohash code.

Parameters:

latitude - the latitude

longitude - the longitude

Returns:

The generated geohash from the given latitude and longitude.

getAdjacent

public static String getAdjacent(String geohash,
                                 String direction)

Gets the adjacent from the given direction. For instance if direction is 'top' then the top adjacent geohash code will be returned.

Parameters:

geohash - the geohash

direction - the direction

Returns:

the geohash code for the adjacent from the given direction.

getAdjacent

public static String getAdjacent(String geohash,
                                 String... directions)

Gets the adjacent from the given directions. For instance if directions is 'top' and 'feft' then the topleft adjacent geohash code will be returned.

Parameters:

geohash - the geohash

directions - the directions

Returns:

the geohash code for the adjacent from the given directions.

getAllAdjacentAreasList

public static List<String> getAllAdjacentAreasList(String geohash)

Gets the all adjacent areas list.

Parameters:

geohash - the geohash

Returns:

the all adjacent areas list

getAllAdjacentAreasMap

public static Map<String,String> getAllAdjacentAreasMap(String geohash)

Gets the geohash cells around the given geohash cell. With other words it gets eight cells around the given geohash cell so the first ring inclusive the given geohash cell.

Parameters:

geohash - the geohash

Returns:

all geohash cells around the given geohash cell.

getFirstAndSecondRingRegion

public static FirstAndSecondRingRegion getFirstAndSecondRingRegion(String geohash)

Gets the geohash cells of the first and second ring region around the given geohash cell as a FirstAndSecondRingRegion object.

Parameters:

geohash - the geohash cell.

Returns:

the FirstAndSecondRingRegion that encapsulates the cells of the first and second ring region around the given geohash cell.

getFirstRingRegion

public static FirstRingRegion getFirstRingRegion(String geohash)

Gets the geohash cells around the given geohash cell as a FirstRingRegion object.

Parameters:

geohash - the geohash cell.

Returns:

the FirstRingRegion object calculated from the given geohash value.

getLatitude

public static double getLatitude(String geohash)

Gets the latitude from the given geohash value.

Parameters:

geohash - the geohash

Returns:

the latitude

getLongitude

public static double getLongitude(String geohash)

Gets the longitude from the given geohash value.

Parameters:

geohash - the geohash

Returns:

the longitude

getTwentyFiveAreasMap

public static Map<String,String> getTwentyFiveAreasMap(String geohash)

Gets the eight cells around the given geohash cell so the first ring inclusive the given geohash cell and cells from the second ring. The result is 24 cells plus the given geohash cell.

Parameters:

geohash - the geohash

Returns:

the eight cells around the given geohash cell so the first ring inclusive the given geohash cell and cells from the second ring.

main

public static void main(String[] args)

The main method.

Parameters:

args - the arguments