org.das2.datum

Class EnumerationUnits

java.lang.Object

org.das2.datum.Units

org.das2.datum.EnumerationUnits

public class EnumerationUnits
extends Units

Units class for mapping arbitrary objects to Datums. Nothing about the contract for a Datum requires that they correspond to physical quantities, and we can assign a mapping from numbers to objects using this class. This allows information such as "Cluster 1" or "Spin Flip" to be encoded. This is used to model ordinal or nominal data, as described in http://en.wikipedia.org/wiki/Level_of_measurement

Field Summary

Fields inherited from class org.das2.datum.Units

ampRatio, bytes, bytesPerSecond, cdfEpoch, cdfTT2000, celciusDegrees, centigrade, centimeters, cm_2s_1keV_1, cm_2s_1MeV_1, cmps, days, dB, decimalYear, deg, degrees, degrees2, dimensionless, dollars, euros, ev, eV, fahrenheitDegrees, fahrenheitScale, gigaHertz, hertz, hours, hours2, inches, julianDay, kelvin, keV, kiloBytes, kiloBytesPerSecond, kiloHertz, kiloMeters, log10Ratio, logERatio, megaHertz, meters, MeV, microseconds, microseconds2, microseconds3, millimeters, milliseconds, milliseconds2, minutes, mj1958, mjd, mps, ms1970, nanoseconds, ns, nT, pcm3, percent, percentIncrease, picoseconds, radians, rgbColor, rupee, seconds, seconds2, t1970, t2000, t2010, typographicPoints, us1970, us1980, us2000, us2020, v2pm2Hz, wpm2, years, yen

Constructor Summary

Constructors

Constructor and Description
EnumerationUnits(java.lang.String id)
EnumerationUnits(java.lang.String id, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
Datum	add(java.lang.Number a, java.lang.Number b, Units bUnits)
double	convertDoubleTo(Units toUnits, double value) convert the double in this units' space to toUnits' space.
static EnumerationUnits	create(java.lang.Object o) create the enumeration unit with the given context.
Datum	createDatum(Datum value) create a Datum with the units.
Datum	createDatum(double d)
Datum	createDatum(double d, double resolution)
Datum	createDatum(int value)
Datum	createDatum(int ival, java.lang.Object sval) creates the datum, explicitly setting the ordinal.
Datum	createDatum(int ival, java.lang.Object sval, int color) creates the datum, explicitly setting the ordinal.
Datum	createDatum(long value)
Datum	createDatum(java.lang.Number value)
Datum	createDatum(java.lang.Object object) return the Datum that represents this object, or create a Datum for the object.
static Datum	createDatumAndUnits(java.lang.Object object)
DatumVector	createDatumVector(java.lang.Object[] objects)
Datum	divide(java.lang.Number a, java.lang.Number b, Units bUnits)
int	getColor(Datum d) return color suggestion for this value.
DatumFormatterFactory	getDatumFormatterFactory() return the formatter factor for this Datum.
Datum	getFillDatum() return the datum for ""
double	getFillDouble() return the double for ""
int	getHighestOrdinal()
java.lang.Object	getObject(Datum datum) return the object (typically a string) associated with this Datum
java.util.Map<java.lang.Integer,Datum>	getValues() provides access to map of all values.
boolean	hasFillDatum() true if fill has been defined, which is the empty string or all spaces.
boolean	isFill(java.lang.Number value)
Datum	multiply(java.lang.Number a, java.lang.Number b, Units bUnits)
Datum	parse(java.lang.String s) parse the string in the context of these units.
Datum	subtract(java.lang.Number a, java.lang.Number b, Units bUnits)
java.lang.String	toString()

Methods inherited from class org.das2.datum.Units

format, getAllUnits, getBasis, getByName, getCanonicalUnit, getConverter, getConverter, getConvertibleUnits, getId, getOffsetUnits, grannyFormat, isConvertibleTo, isFill, isValid, lookupTimeLengthUnit, lookupTimeUnits, lookupTimeUnits, lookupUnits, main, nominal, nominal, registerConverter

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumerationUnits

public EnumerationUnits(java.lang.String id)

EnumerationUnits

public EnumerationUnits(java.lang.String id,
                        java.lang.String description)

Method Detail

createDatumAndUnits

public static Datum createDatumAndUnits(java.lang.Object object)

createDatum

public Datum createDatum(int ival,
                         java.lang.Object sval,
                         int color)

creates the datum, explicitly setting the ordinal. Use with caution.

Parameters:

ival - the integer value of the datum

sval - the object to associate. This can be an object for legacy reasons, but should be a String.

color - RGB color to associate with this value.

Returns:

the Datum, which may have been created already.

Throws:

java.lang.IllegalArgumentException - if this ordinal is already taken by a different value.

getColor

public int getColor(Datum d)

return color suggestion for this value. Note this color is not always used.

Parameters:

d - the datum

Returns:

the color suggestions

createDatum

public Datum createDatum(int ival,
                         java.lang.Object sval)

creates the datum, explicitly setting the ordinal. Use with caution.

Parameters:

ival - the integer value of the datum

sval - the object to associate. This can be an object for legacy reasons.

Returns:

a Datum representing sval.

Throws:

java.lang.IllegalArgumentException - if this ordinal is already taken by a different value.

createDatumVector

public DatumVector createDatumVector(java.lang.Object[] objects)

hasFillDatum

public boolean hasFillDatum()

true if fill has been defined, which is the empty string or all spaces.

Returns:

true if fill has been defined.

createDatum

public Datum createDatum(java.lang.Object object)

return the Datum that represents this object, or create a Datum for the object. The object should be a String, but to support legacy applications it is an object

Parameters:

object - an object, typically a string.

Returns:

Datum representing the object.

See Also:

createDatum( Datum )

getValues

public java.util.Map<java.lang.Integer,Datum> getValues()

provides access to map of all values.

Returns:

all the values

createDatum

public Datum createDatum(int value)

Specified by:

createDatum in class Units

createDatum

public Datum createDatum(long value)

Specified by:

createDatum in class Units

createDatum

public Datum createDatum(java.lang.Number value)

Specified by:

createDatum in class Units

getObject

public java.lang.Object getObject(Datum datum)

return the object (typically a string) associated with this Datum

Parameters:

datum -

Returns:

the object associated with the Datum.

create

public static EnumerationUnits create(java.lang.Object o)

create the enumeration unit with the given context.

Parameters:

o -

Returns:

createDatum

public Datum createDatum(double d)

Specified by:

createDatum in class Units

createDatum

public Datum createDatum(double d,
                         double resolution)

Specified by:

createDatum in class Units

getDatumFormatterFactory

public DatumFormatterFactory getDatumFormatterFactory()

Description copied from class: Units

return the formatter factor for this Datum.

Specified by:

getDatumFormatterFactory in class Units

Returns:

subtract

public Datum subtract(java.lang.Number a,
                      java.lang.Number b,
                      Units bUnits)

Specified by:

subtract in class Units

add

public Datum add(java.lang.Number a,
                 java.lang.Number b,
                 Units bUnits)

Specified by:

add in class Units

divide

public Datum divide(java.lang.Number a,
                    java.lang.Number b,
                    Units bUnits)

Specified by:

divide in class Units

multiply

public Datum multiply(java.lang.Number a,
                      java.lang.Number b,
                      Units bUnits)

Specified by:

multiply in class Units

parse

public Datum parse(java.lang.String s)
            throws java.text.ParseException

Description copied from class: Units

parse the string in the context of these units. The string may throw a parse exception if it cannot be parsed, or may return a known unit.

Specified by:

parse in class Units

Returns:

Throws:

java.text.ParseException

getHighestOrdinal

public int getHighestOrdinal()

getFillDouble

public double getFillDouble()

return the double for ""

Overrides:

getFillDouble in class Units

Returns:

getFillDatum

public Datum getFillDatum()

return the datum for ""

Overrides:

getFillDatum in class Units

Returns:

isFill

public boolean isFill(java.lang.Number value)

Overrides:

isFill in class Units

convertDoubleTo

public double convertDoubleTo(Units toUnits,
                              double value)

Description copied from class: Units

convert the double in this units' space to toUnits' space.

Overrides:

convertDoubleTo in class Units

Parameters:

toUnits - the units.

value - the value in toUnits.

Returns:

the double in the new units system.

toString

public java.lang.String toString()

Overrides:

toString in class Units

createDatum

public Datum createDatum(Datum value)

Description copied from class: Units

create a Datum with the units. For example,

• Units.cm.createDatum('5m') → '500cm'
• eu.createDatum(datum('voyager1')) will convert to the new ordinal units.

Specified by:

createDatum in class Units

Returns: