org.das2.datum

Class UnitsConverter

java.lang.Object

org.das2.datum.UnitsConverter

Direct Known Subclasses:

DecimalYearConverter, LeapSecondsConverter, UnitsConverter.Appended, UnitsConverter.ScaleOffset

public abstract class UnitsConverter
extends java.lang.Object

Units Converter object performs scale/offset conversions, but can also be used any double-to-double conversion, and contains an implementation to chain multiple conversions together.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitsConverter.Appended
static class	UnitsConverter.ScaleOffset

Field Summary

Fields

Modifier and Type	Field and Description
static UnitsConverter	CENTI
static UnitsConverter	GIGA
static UnitsConverter	IDENTITY No conversion, where convert trivially returns the value.
protected UnitsConverter	inverse
static UnitsConverter	KILO
static UnitsConverter	LOOSE_IDENTITY Allow conversion, but this is a flag that indicates the result should be dimensionless because the Ratiometric units were not convertible.
static UnitsConverter	MEGA
static UnitsConverter	MICRO
static UnitsConverter	MILLI
static UnitsConverter	NANO
static UnitsConverter	PICO
static UnitsConverter	TERA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnitsConverter()
protected	UnitsConverter(UnitsConverter inverse)

Method Summary

Modifier and Type	Method and Description
UnitsConverter	append(UnitsConverter that)
abstract double	convert(double value) convert the value in the source units to the target units.
java.lang.Number	convert(java.lang.Number number) convert the value in the source units to the target units, preserving the data type.
static UnitsConverter	getConverter(Units fromUnits, Units toUnits) lookup the UnitsConverter object that takes numbers from fromUnits to toUnits.
abstract UnitsConverter	getInverse()

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY

public static final UnitsConverter IDENTITY

No conversion, where convert trivially returns the value.

LOOSE_IDENTITY

public static final UnitsConverter LOOSE_IDENTITY

Allow conversion, but this is a flag that indicates the result should be dimensionless because the Ratiometric units were not convertible.

TERA

public static final UnitsConverter TERA

GIGA

public static final UnitsConverter GIGA

MEGA

public static final UnitsConverter MEGA

KILO

public static final UnitsConverter KILO

MILLI

public static final UnitsConverter MILLI

CENTI

public static final UnitsConverter CENTI

MICRO

public static final UnitsConverter MICRO

NANO

public static final UnitsConverter NANO

PICO

public static final UnitsConverter PICO

inverse

protected UnitsConverter inverse

Constructor Detail

UnitsConverter

protected UnitsConverter()

UnitsConverter

protected UnitsConverter(UnitsConverter inverse)

Method Detail

getInverse

public abstract UnitsConverter getInverse()

convert

public abstract double convert(double value)

convert the value in the source units to the target units.

Parameters:

value - value in source units.

Returns:

value in target units.

convert

public java.lang.Number convert(java.lang.Number number)

convert the value in the source units to the target units, preserving the data type. TODO: study where this is used, because it seems like the unit should determine its use. For example, Units.CDF_TT2000 might want Long.

Parameters:

number - value in source units.

Returns:

value in target units.

append

public UnitsConverter append(UnitsConverter that)

getConverter

public static UnitsConverter getConverter(Units fromUnits,
                                          Units toUnits)

lookup the UnitsConverter object that takes numbers from fromUnits to toUnits. This will chain together UnitsConverters registered via units.registerConverter.

Parameters:

fromUnits -

toUnits -

Returns:

UnitsConverter object

Throws:

InconvertibleUnitsException - when the conversion is not possible.