org.ka2ddo.yaac.util

Class LatLonFormatter

java.lang.Object

org.ka2ddo.yaac.util.LatLonFormatter

public class LatLonFormatter
extends java.lang.Object

Provide a formatter for a latitude or longitude value in degrees/minutes/fractional minutes and direction (or some other format style for GUI display).

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LatLonFormatter.Format Define the supported different formats for latitude and longitude display.

Field Summary

Fields

Modifier and Type	Field and Description
static LatLonFormatter	LAT
static LatLonFormatter	LON

Constructor Summary

Constructors

Constructor and Description
LatLonFormatter(boolean isLat, boolean forDisplay) Create a LatLonFormatter.
LatLonFormatter(boolean isLat, boolean forDisplay, LatLonFormatter.Format latLonFormat) Create a LatLonFormatter.

Method Summary

Modifier and Type	Method and Description
static void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Register a PropertyChangeListener to be informed of changes to the global format value.
java.lang.String	format(double value) Format the specified latitude or longitude value into a String.
static java.lang.String	format(double latValue, double lonValue) Format the specified latitude and longitude pair according to the current global format.
static LatLonFormatter.Format	getGlobalLatLonFormat() Get the current default format to use for formatting latitudes and longitudes.
static void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Unregister a PropertyChangeListener so it will no longer be informed of changes to the global format value.
static void	setGlobalLatLonFormat(LatLonFormatter.Format globalLatLonFormat) Set the default format to use for formatting latitudes and longitudes.

Methods inherited from class java.lang.Object

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

Field Detail

LAT

public static final LatLonFormatter LAT

LON

public static final LatLonFormatter LON

Constructor Detail

LatLonFormatter

public LatLonFormatter(boolean isLat,
                       boolean forDisplay)

Create a LatLonFormatter.

Parameters:

isLat - boolean true if for formatting latitudes, false for formatting longitudes.

forDisplay - boolean true if for formatting human-readable displays, false for formatting for machine-to-machine transfers

LatLonFormatter

public LatLonFormatter(boolean isLat,
                       boolean forDisplay,
                       LatLonFormatter.Format latLonFormat)

Create a LatLonFormatter.

Parameters:

isLat - boolean true if for formatting latitudes, false for formatting longitudes.

forDisplay - boolean true if for formatting human-readable displays, false for formatting for machine-to-machine transfers

latLonFormat - Format for this formatter, ignoring the global format value

See Also:

getGlobalLatLonFormat()

Method Detail

getGlobalLatLonFormat

public static LatLonFormatter.Format getGlobalLatLonFormat()

Get the current default format to use for formatting latitudes and longitudes.

Returns:

Format enum

setGlobalLatLonFormat

public static void setGlobalLatLonFormat(LatLonFormatter.Format globalLatLonFormat)

Set the default format to use for formatting latitudes and longitudes.

Parameters:

globalLatLonFormat - Format enum identifying the desired format

addPropertyChangeListener

public static void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Register a PropertyChangeListener to be informed of changes to the global format value.

Parameters:

l - PropertyChangeListener to register

removePropertyChangeListener

public static void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Unregister a PropertyChangeListener so it will no longer be informed of changes to the global format value.

Parameters:

l - PropertyChangeListener to unregister

format

public java.lang.String format(double value)

Format the specified latitude or longitude value into a String.

Parameters:

value - double latitude or longitude in fractional degrees North or East

Returns:

String formatted according to the format, isLat, and forDisplay properties of this LatLonFormatter

format

public static java.lang.String format(double latValue,
                                      double lonValue)

Format the specified latitude and longitude pair according to the current global format. This allows formatting in UTM format (which implicitly merges latitude and longitude together).

Parameters:

latValue - latitude in fractional degrees North

lonValue - longitude in fractional degrees East

Returns:

formatted String