CoordTools (module.utils 1.0 API)

java.lang.Object
- nc.ird.module.utils.CoordTools

```
public final class CoordTools
extends Object
```
Tools for coordonates

Author:

Mickael Tricot, Adrien Cheype

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`DEGREES` Degrees character
`static int`	`LATITUDE_LENGTH` Latitude length
`static int`	`LATITUDE_MAX_DEGREES` Latitude max degrees
`static BigDecimal`	`LATITUDE_MAX_MINUTES` Latitude max minutes
`static String`	`LATITUDE_MAX_MINUTES_STRING` Latitude max minutes
`static int`	`LATITUDE_MIN_DEGREES` Latitude min degrees
`static BigDecimal`	`LATITUDE_MIN_MINUTES` Latitude min minutes
`static String`	`LATITUDE_MIN_MINUTES_STRING` Latitude min minutes
`static Character[]`	`LATITUDE_ORIENTATIONS` Latitude orientations
`static int`	`LONGITUDE_LENGTH` Longitude length
`static int`	`LONGITUDE_MAX_DEGREES` Longitude max degrees
`static BigDecimal`	`LONGITUDE_MAX_MINUTES` Longitude max minutes
`static String`	`LONGITUDE_MAX_MINUTES_STRING` Longitude max minutes
`static int`	`LONGITUDE_MIN_DEGREES` Longitude min degrees
`static BigDecimal`	`LONGITUDE_MIN_MINUTES` Longitude min minutes
`static String`	`LONGITUDE_MIN_MINUTES_STRING` Longitude min minutes
`static Character[]`	`LONGITUDE_ORIENTATIONS` Longitude orientations
`static char`	`MINUTES` Minutes character
`static char`	`MINUTES_SEPARATOR` Minutes separator

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`latitude(Integer d, BigDecimal m, Character o)` Format a latitude (dd.mm.sss"o)
`static Integer`	`latitudeDegrees(String latitude)` Retrieve the degrees from a complete latitude
`static BigDecimal`	`latitudeMinutes(String latitude)` Retrieve the minutes from a complete latitude
`static Character`	`latitudeOrientation(String latitude)` Retrieve the orientation from a complete latitude
`static String`	`longitude(Integer d, BigDecimal m, Character o)` Format a longitude (ddd.mm'ss"o)
`static Integer`	`longitudeDegrees(String longitude)` Retrieve the degrees from a complete longitude
`static BigDecimal`	`longitudeMinutes(String longitude)` Retrieve the minutes from a complete longitude
`static Character`	`longitudeOrientation(String longitude)` Retrieve the orientation from a complete longitude
`static boolean`	`validateLatitude(String latitude)` Validate a latitude (ddd.mm.sss"o)
`static boolean`	`validateLongitude(String longitude)` Validate a longitude (dd.mm.sss"o)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEGREES
```
public static final char DEGREES
```
    Degrees character
    
    See Also:
    Constant Field Values
  - LATITUDE_LENGTH
```
public static final int LATITUDE_LENGTH
```
    Latitude length
    
    See Also:
    Constant Field Values
  - LATITUDE_MAX_DEGREES
```
public static final int LATITUDE_MAX_DEGREES
```
    Latitude max degrees
    
    See Also:
    Constant Field Values
  - LATITUDE_MAX_MINUTES_STRING
```
public static final String LATITUDE_MAX_MINUTES_STRING
```
    Latitude max minutes
    
    See Also:
    Constant Field Values
  - LATITUDE_MAX_MINUTES
```
public static final BigDecimal LATITUDE_MAX_MINUTES
```
    Latitude max minutes
  - LATITUDE_MIN_DEGREES
```
public static final int LATITUDE_MIN_DEGREES
```
    Latitude min degrees
    
    See Also:
    Constant Field Values
  - LATITUDE_MIN_MINUTES_STRING
```
public static final String LATITUDE_MIN_MINUTES_STRING
```
    Latitude min minutes
    
    See Also:
    Constant Field Values
  - LATITUDE_MIN_MINUTES
```
public static final BigDecimal LATITUDE_MIN_MINUTES
```
    Latitude min minutes
  - LATITUDE_ORIENTATIONS
```
public static final Character[] LATITUDE_ORIENTATIONS
```
    Latitude orientations
  - LONGITUDE_LENGTH
```
public static final int LONGITUDE_LENGTH
```
    Longitude length
    
    See Also:
    Constant Field Values
  - LONGITUDE_MAX_DEGREES
```
public static final int LONGITUDE_MAX_DEGREES
```
    Longitude max degrees
    
    See Also:
    Constant Field Values
  - LONGITUDE_MAX_MINUTES_STRING
```
public static final String LONGITUDE_MAX_MINUTES_STRING
```
    Longitude max minutes
    
    See Also:
    Constant Field Values
  - LONGITUDE_MAX_MINUTES
```
public static final BigDecimal LONGITUDE_MAX_MINUTES
```
    Longitude max minutes
  - LONGITUDE_MIN_DEGREES
```
public static final int LONGITUDE_MIN_DEGREES
```
    Longitude min degrees
    
    See Also:
    Constant Field Values
  - LONGITUDE_MIN_MINUTES_STRING
```
public static final String LONGITUDE_MIN_MINUTES_STRING
```
    Longitude min minutes
    
    See Also:
    Constant Field Values
  - LONGITUDE_MIN_MINUTES
```
public static final BigDecimal LONGITUDE_MIN_MINUTES
```
    Longitude min minutes
  - LONGITUDE_ORIENTATIONS
```
public static final Character[] LONGITUDE_ORIENTATIONS
```
    Longitude orientations
  - MINUTES
```
public static final char MINUTES
```
    Minutes character
    
    See Also:
    Constant Field Values
  - MINUTES_SEPARATOR
```
public static final char MINUTES_SEPARATOR
```
    Minutes separator
    
    See Also:
    Constant Field Values
- Method Detail
  - latitude
```
public static String latitude(Integer d,
              BigDecimal m,
              Character o)
```
    Format a latitude (dd.mm.sss"o)
    
    Parameters:
    d - Degrees (0-90)
    m - Minutes (00.000-59.999)
    o - Orientation (N-S)
    
    Returns:
    Latitude
  - latitudeDegrees
```
public static Integer latitudeDegrees(String latitude)
```
    Retrieve the degrees from a complete latitude
    
    Parameters:
    latitude - Latitude
    
    Returns:
    Degrees
  - latitudeMinutes
```
public static BigDecimal latitudeMinutes(String latitude)
```
    Retrieve the minutes from a complete latitude
    
    Parameters:
    latitude - Latitude
    
    Returns:
    Minutes
  - latitudeOrientation
```
public static Character latitudeOrientation(String latitude)
```
    Retrieve the orientation from a complete latitude
    
    Parameters:
    latitude - Latitude
    
    Returns:
    Orientation
  - longitude
```
public static String longitude(Integer d,
               BigDecimal m,
               Character o)
```
    Format a longitude (ddd.mm'ss"o)
    
    Parameters:
    d - Degrees (0-180)
    m - Minutes (00.000-59.999)
    o - Orientation (E-W)
    
    Returns:
    Longitude
  - longitudeDegrees
```
public static Integer longitudeDegrees(String longitude)
```
    Retrieve the degrees from a complete longitude
    
    Parameters:
    longitude - Longitude
    
    Returns:
    Degrees
  - longitudeMinutes
```
public static BigDecimal longitudeMinutes(String longitude)
```
    Retrieve the minutes from a complete longitude
    
    Parameters:
    longitude - Longitude
    
    Returns:
    Minutes
  - longitudeOrientation
```
public static Character longitudeOrientation(String longitude)
```
    Retrieve the orientation from a complete longitude
    
    Parameters:
    longitude - Longitude
    
    Returns:
    Orientation
  - validateLatitude
```
public static boolean validateLatitude(String latitude)
```
    Validate a latitude (ddd.mm.sss"o)
    
    Parameters:
    latitude - Latitude
    
    Returns:
    TRUE if the latitude is valid
  - validateLongitude
```
public static boolean validateLongitude(String longitude)
```
    Validate a longitude (dd.mm.sss"o)
    
    Parameters:
    longitude - Longitude
    
    Returns:
    TRUE if the longitude is valid

Class CoordTools

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEGREES

LATITUDE_LENGTH

LATITUDE_MAX_DEGREES

LATITUDE_MAX_MINUTES_STRING

LATITUDE_MAX_MINUTES

LATITUDE_MIN_DEGREES

LATITUDE_MIN_MINUTES_STRING

LATITUDE_MIN_MINUTES

LATITUDE_ORIENTATIONS

LONGITUDE_LENGTH

LONGITUDE_MAX_DEGREES

LONGITUDE_MAX_MINUTES_STRING

LONGITUDE_MAX_MINUTES

LONGITUDE_MIN_DEGREES

LONGITUDE_MIN_MINUTES_STRING

LONGITUDE_MIN_MINUTES

LONGITUDE_ORIENTATIONS

MINUTES

MINUTES_SEPARATOR

Method Detail

latitude

latitudeDegrees

latitudeMinutes

latitudeOrientation

longitude

longitudeDegrees

longitudeMinutes

longitudeOrientation

validateLatitude

validateLongitude