org.gbif.common.parsers.geospatial

Class CellIdUtils

java.lang.Object

org.gbif.common.parsers.geospatial.CellIdUtils

public class CellIdUtils
extends Object

Utilities for dealing with CellId.

Method Summary

Modifier and Type	Method and Description
static LatLngBoundingBox	getBoundingBoxForCells(List<Integer> cellIds) Creates a bounding box for the list of unordered cell ids.
static int	getCellIdFor(double latitude) Get cell id.
static Set<Integer>	getCellsEnclosedBy(double minLat, double maxLat, double minLong, double maxLong) Gets the list of cells that are enclosed within the bounding box.
static Integer[]	getCentiCellIdForBoundingBox(double minLongitude, double minLatitude, double maxLongitude, double maxLatitude) Returns the cell id and centi cell id for the supplied bounding box, Returning null if the supplied bounding box doesnt enclose a single cell.
static int[]	getMinMaxCellIdsForBoundingBox(double minLongitude, double minLatitude, double maxLongitude, double maxLatitude) Return a min cell id and a max cell id for this bounding box.
static int	getMod360CellIdFor(double longitude) Get mod 360 cell id.
static boolean	isCellIdInBoundingBox(int cellId, int minCellId, int maxCellId) Returns true if the supplied cell id lies in the bounding box demarcated by the min and max cell ids supplied.
static void	main(String[] args) For ease of conversion
static LatLngBoundingBox	toBoundingBox(int cellId) Returns the box of the given cell This may require some more work to avoid divide rounding errors
static LatLngBoundingBox	toBoundingBox(int cellId, int centiCellId) Returns the box of the given cell and centi cell An attempt has been made to avoid rounding errors with doubles, but may need revisited
static int	toCellId(Double latitude, Double longitude) Determines the cell id for the Lat / Long provided.
static int	toCentiCellId(Double latitude, Double longitude) Determines the centi cell id for the given values

Methods inherited from class java.lang.Object

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

Method Detail

toCellId

public static int toCellId(Double latitude,
                           Double longitude)
                    throws UnableToGenerateCellIdException

Determines the cell id for the Lat / Long provided.

Parameters:

latitude - Which may be null

longitude - Which may be null

Returns:

The cell id for the Lat Long pair

Throws:

UnableToGenerateCellIdException - Should the lat long be null or invalid

getMod360CellIdFor

public static int getMod360CellIdFor(double longitude)

Get mod 360 cell id.

getCellIdFor

public static int getCellIdFor(double latitude)

Get cell id.

isCellIdInBoundingBox

public static boolean isCellIdInBoundingBox(int cellId,
                                            int minCellId,
                                            int maxCellId)
                                     throws Exception

Returns true if the supplied cell id lies in the bounding box demarcated by the min and max cell ids supplied.

Throws:

Exception

toCentiCellId

public static int toCentiCellId(Double latitude,
                                Double longitude)
                         throws UnableToGenerateCellIdException

Determines the centi cell id for the given values

Parameters:

latitude - Which may be null

longitude - Which may be null

Returns:

The centi cell id within the cell for the lat long

Throws:

UnableToGenerateCellIdException - Shoudl the lat long be null or invalid

toBoundingBox

public static LatLngBoundingBox toBoundingBox(int cellId)

Returns the box of the given cell This may require some more work to avoid divide rounding errors

Parameters:

cellId - To return the lat long box of

Returns:

The box

toBoundingBox

public static LatLngBoundingBox toBoundingBox(int cellId,
                                              int centiCellId)

Returns the box of the given cell and centi cell An attempt has been made to avoid rounding errors with doubles, but may need revisited

Parameters:

cellId - To return the lat long box of

centiCellId - within the box

Returns:

The box

getCellsEnclosedBy

public static Set<Integer> getCellsEnclosedBy(double minLat,
                                              double maxLat,
                                              double minLong,
                                              double maxLong)
                                       throws UnableToGenerateCellIdException

Gets the list of cells that are enclosed within the bounding box. Cells that are partially enclosed are returned also TODO implement this properly, the current version will include cells that are partially included on the bottom and left, but not the top and right

Returns:

The cells that are enclosed by the bounding box

Throws:

UnableToGenerateCellIdException - if the lat longs are invalid

getMinMaxCellIdsForBoundingBox

public static int[] getMinMaxCellIdsForBoundingBox(double minLongitude,
                                                   double minLatitude,
                                                   double maxLongitude,
                                                   double maxLatitude)
                                            throws UnableToGenerateCellIdException

Return a min cell id and a max cell id for this bounding box.

Returns:

the minCellId in int[0] and maxCellId in int[1]

Throws:

UnableToGenerateCellIdException

getBoundingBoxForCells

public static LatLngBoundingBox getBoundingBoxForCells(List<Integer> cellIds)

Creates a bounding box for the list of unordered cell ids.

Returns:

a LatLngBoundingBox that encapsulates this list of cell ids.

getCentiCellIdForBoundingBox

public static Integer[] getCentiCellIdForBoundingBox(double minLongitude,
                                                     double minLatitude,
                                                     double maxLongitude,
                                                     double maxLatitude)
                                              throws UnableToGenerateCellIdException

Returns the cell id and centi cell id for the supplied bounding box, Returning null if the supplied bounding box doesnt enclose a single cell. If the bounding box encloses a single cell but not a centi cell, a Integer[] of length 1 is returned with containing the cell id. Otherwise a Integer array of length 2, with Integer[0] being the cell id, Integer[1] being the centi cell.

Throws:

UnableToGenerateCellIdException

main

public static void main(String[] args)

For ease of conversion

Parameters:

args - See usage