Package ninja.pranav.algorithms.gridpointcode

Class GPC

java.lang.Object

ninja.pranav.algorithms.gridpointcode.GPC

public final class GPC
extends Object

GPC class.

Version:

$Id: $Id

Author:

pranav.ninja

Method Summary

Modifier and Type	Method	Description
static Coordinates	Decode(String gridPointCode)	Decode Grid Point Code to Coordinates
static String	Encode(double latitude, double longitude)	Encode coordinates
static String	Encode(double latitude, double longitude, Boolean formatted)	Encode coordinates
static Validation	IsValid(double latitude, double longitude)	Check if coordinates are valid
static Validation	IsValid(String gridPointCode)	Check if grid point code is valid

Methods inherited from class java.lang.Object

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

Method Detail

Encode

public static String Encode(double latitude,
                            double longitude)

Encode coordinates

Parameters:

latitude - Latitude in Decimal Degrees

longitude - Longitude in Decimal Degrees

Returns:

Grid Point Code

Throws:

IllegalArgumentException - if latitude or longitude is invalid.

Encode

public static String Encode(double latitude,
                            double longitude,
                            Boolean formatted)

Encode coordinates

Parameters:

latitude - Latitude in Decimal Degrees

longitude - Longitude in Decimal Degrees

formatted - True if GPC needs to be formatted otherwise false

Returns:

Grid Point Code

Throws:

IllegalArgumentException - if latitude or longitude is invalid.

IsValid

public static Validation IsValid(double latitude,
                                 double longitude)

Check if coordinates are valid

Parameters:

latitude - Latitude in Decimal Degrees

longitude - Longitude in Decimal Degrees

Returns:

Validation object containing status and message if any.

Decode

public static Coordinates Decode(String gridPointCode)

Decode Grid Point Code to Coordinates

Parameters:

gridPointCode - Grid Point Code

Returns:

Latitude and Longitude in Decimal Degrees

Throws:

IllegalArgumentException - if { @param gridPointCode } is NULL, blank, whitespaces or invalid.

IsValid

public static Validation IsValid(String gridPointCode)

Check if grid point code is valid

Parameters:

gridPointCode - Grid Point Code

Returns:

Validity status with message if any