ome.model.units

Class Temperature

java.lang.Object

ome.model.units.Temperature

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

@Embeddable
public class Temperature
extends Object
implements Serializable, Filterable, Unit

class storing both a Temperature and a unit for that Temperature (e.g. m, in, ly, etc.) encapsulated in a UnitsTemperature instance. As also described in the remoting definition (.ice) for Temperature, this is an embedded class meaning that the columns here do not appear in their own table but exist directly on the containing object. Like Details and Permissions, instances do not contain long identifiers and cannot be persisted on their own.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNIT
static String	VALUE

Constructor Summary

Constructors

Constructor and Description
Temperature() Deprecated.
Temperature(double d, String u)
Temperature(double d, ome.units.unit.Unit<ome.units.quantity.Temperature> unit)
Temperature(double d, UnitsTemperature u)
Temperature(ome.units.quantity.Temperature value)

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter filter)
static ome.units.quantity.Temperature	convertTemperature(Temperature t) FIXME: this should likely take a default so that locations which don't want an exception can have log.warn("Using new PositiveFloat(1.0)!"
static Temperature	convertTemperature(Temperature value, String target)
static Temperature	convertTemperature(Temperature value, ome.units.unit.Unit<ome.units.quantity.Temperature> ul)
boolean	equals(Object obj)
UnitsTemperature	getUnit() Many-to-one field ome.model.units.Temperature.unit (ome.model.enums.UnitsTemperature).
double	getValue() value of this unit-field.
int	hashCode()
static ome.xml.model.enums.UnitsTemperature	makeTemperatureUnitXML(String unit)
static ome.units.quantity.Temperature	makeTemperatureXML(double d, String unit)
void	setUnit(UnitsTemperature unit)
void	setValue(double value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALUE

public static final String VALUE

See Also:

Constant Field Values

UNIT

public static final String UNIT

See Also:

Constant Field Values

Constructor Detail

Temperature

@Deprecated
public Temperature()

Deprecated.

no-arg constructor to keep Hibernate happy.

Temperature

public Temperature(double d,
                   String u)

Temperature

public Temperature(double d,
                   UnitsTemperature u)

Temperature

public Temperature(double d,
                   ome.units.unit.Unit<ome.units.quantity.Temperature> unit)

Temperature

public Temperature(ome.units.quantity.Temperature value)

Method Detail

makeTemperatureUnitXML

public static ome.xml.model.enums.UnitsTemperature makeTemperatureUnitXML(String unit)

makeTemperatureXML

public static ome.units.quantity.Temperature makeTemperatureXML(double d,
                                                                String unit)

convertTemperature

public static ome.units.quantity.Temperature convertTemperature(Temperature t)

FIXME: this should likely take a default so that locations which don't want an exception can have log.warn("Using new PositiveFloat(1.0)!", e); return new PositiveFloat(1.0); or similar.

convertTemperature

public static Temperature convertTemperature(Temperature value,
                                             ome.units.unit.Unit<ome.units.quantity.Temperature> ul)

convertTemperature

public static Temperature convertTemperature(Temperature value,
                                             String target)

getValue

public double getValue()

value of this unit-field. It will be persisted to a column with the same name as the containing field. For example, imagingEnvironment.getTemperature() which is of type Temperature will be stored in a column "imagingEnvironmenttemperature".

Specified by:

getValue in interface Unit

getUnit

public UnitsTemperature getUnit()

Many-to-one field ome.model.units.Temperature.unit (ome.model.enums.UnitsTemperature). These values are stored in a column suffixed by "Unit". Whereas value for physicalSizeX will be stored as "imagingEnvironment.temperature", the unit enum will be stored as "imagingEnvironment.temperatureUnit".

Specified by:

getUnit in interface Unit

setValue

public void setValue(double value)

Specified by:

setValue in interface Unit

setUnit

public void setUnit(UnitsTemperature unit)

acceptFilter

public boolean acceptFilter(Filter filter)

Specified by:

acceptFilter in interface Filterable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object