org.openstreetmap.josm.gui

Class NavigatableComponent.SystemOfMeasurement

java.lang.Object

org.openstreetmap.josm.gui.NavigatableComponent.SystemOfMeasurement

Enclosing class:

NavigatableComponent

public static class NavigatableComponent.SystemOfMeasurement
extends Object

A system of units used to express length and area measurements.

Since:

3406

Field Summary

Fields

Modifier and Type	Field and Description
String	aName First unit used to format text.
String	areaCustomName Specific optional area unit.
double	areaCustomValue Specific optional area value, in squared meters, between aValue*aValue and bValue*bValue.
double	aValue First value, in meters, used to translate unit according to above formula.
String	bName Second unit used to format text.
double	bValue Second value, in meters, used to translate unit according to above formula.

Constructor Summary

Constructors

Constructor and Description
SystemOfMeasurement(double aValue, String aName, double bValue, String bName) System of measurement.
SystemOfMeasurement(double aValue, String aName, double bValue, String bName, double areaCustomValue, String areaCustomName) System of measurement.

Method Summary

Modifier and Type	Method and Description
private static String	formatText(double v, String unit, NumberFormat format)
String	getAreaText(double area) Returns the text describing the given area in this system of measurement.
String	getAreaText(double area, NumberFormat format, double threshold) Returns the text describing the given area in this system of measurement.
String	getDistText(double dist) Returns the text describing the given distance in this system of measurement.
String	getDistText(double dist, NumberFormat format, double threshold) Returns the text describing the given distance in this system of measurement.

Methods inherited from class java.lang.Object

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

Field Detail

aValue

public final double aValue

First value, in meters, used to translate unit according to above formula.

bValue

public final double bValue

Second value, in meters, used to translate unit according to above formula.

aName

public final String aName

First unit used to format text.

bName

public final String bName

Second unit used to format text.

areaCustomValue

public final double areaCustomValue

Specific optional area value, in squared meters, between aValue*aValue and bValue*bValue. Set to -1 if not used.

Since:

5870

areaCustomName

public final String areaCustomName

Specific optional area unit. Set to null if not used.

Since:

5870

Constructor Detail

SystemOfMeasurement

public SystemOfMeasurement(double aValue,
                           String aName,
                           double bValue,
                           String bName)

System of measurement. Currently covers only length (and area) units. If a quantity x is given in m (x_m) and in unit a (x_a) then it translates as x_a == x_m / aValue

Parameters:

aValue - First value, in meters, used to translate unit according to above formula.

aName - First unit used to format text.

bValue - Second value, in meters, used to translate unit according to above formula.

bName - Second unit used to format text.

SystemOfMeasurement

public SystemOfMeasurement(double aValue,
                           String aName,
                           double bValue,
                           String bName,
                           double areaCustomValue,
                           String areaCustomName)

System of measurement. Currently covers only length (and area) units. If a quantity x is given in m (x_m) and in unit a (x_a) then it translates as x_a == x_m / aValue

Parameters:

aValue - First value, in meters, used to translate unit according to above formula.

aName - First unit used to format text.

bValue - Second value, in meters, used to translate unit according to above formula.

bName - Second unit used to format text.

areaCustomValue - Specific optional area value, in squared meters, between aValue*aValue and bValue*bValue. Set to -1 if not used.

areaCustomName - Specific optional area unit. Set to null if not used.

Since:

5870

Method Detail

getDistText

public String getDistText(double dist)

Returns the text describing the given distance in this system of measurement.

Parameters:

dist - The distance in metres

Returns:

The text describing the given distance in this system of measurement.

getDistText

public String getDistText(double dist,
                          NumberFormat format,
                          double threshold)

Returns the text describing the given distance in this system of measurement.

Parameters:

dist - The distance in metres

format - A NumberFormat to format the area value

threshold - Values lower than this threshold are displayed as "< [threshold]"

Returns:

The text describing the given distance in this system of measurement.

Since:

6422

getAreaText

public String getAreaText(double area)

Returns the text describing the given area in this system of measurement.

Parameters:

area - The area in square metres

Returns:

The text describing the given area in this system of measurement.

Since:

5560

getAreaText

public String getAreaText(double area,
                          NumberFormat format,
                          double threshold)

Returns the text describing the given area in this system of measurement.

Parameters:

area - The area in square metres

format - A NumberFormat to format the area value

threshold - Values lower than this threshold are displayed as "< [threshold]"

Returns:

The text describing the given area in this system of measurement.

Since:

6422

formatText

private static String formatText(double v,
                                 String unit,
                                 NumberFormat format)