ome.model.units

Class Pressure

java.lang.Object

ome.model.units.Pressure

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

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

class storing both a Pressure and a unit for that Pressure (e.g. m, in, ly, etc.) encapsulated in a UnitsPressure instance. As also described in the remoting definition (.ice) for Pressure, 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
Pressure() Deprecated.
Pressure(double d, String u)
Pressure(double d, ome.units.unit.Unit<ome.units.quantity.Pressure> unit)
Pressure(double d, UnitsPressure u)
Pressure(ome.units.quantity.Pressure value)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptFilter(Filter filter)
static ome.units.quantity.Pressure	convertPressure(Pressure 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 Pressure	convertPressure(Pressure value, String target)
static Pressure	convertPressure(Pressure value, ome.units.unit.Unit<ome.units.quantity.Pressure> ul)
boolean	equals(Object obj)
UnitsPressure	getUnit() Many-to-one field ome.model.units.Pressure.unit (ome.model.enums.UnitsPressure).
double	getValue() value of this unit-field.
int	hashCode()
static ome.xml.model.enums.UnitsPressure	makePressureUnitXML(String unit)
static ome.units.quantity.Pressure	makePressureXML(double d, String unit)
void	setUnit(UnitsPressure 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

Pressure

@Deprecated
public Pressure()

Deprecated.

no-arg constructor to keep Hibernate happy.

Pressure

public Pressure(double d,
        String u)

Pressure

public Pressure(double d,
        UnitsPressure u)

Pressure

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

Pressure

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

Method Detail

makePressureUnitXML

public static ome.xml.model.enums.UnitsPressure makePressureUnitXML(String unit)

makePressureXML

public static ome.units.quantity.Pressure makePressureXML(double d,
                                          String unit)

convertPressure

public static ome.units.quantity.Pressure convertPressure(Pressure 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.

convertPressure

public static Pressure convertPressure(Pressure value,
                       ome.units.unit.Unit<ome.units.quantity.Pressure> ul)

convertPressure

public static Pressure convertPressure(Pressure 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.getPressure() which is of type Pressure will be stored in a column "imagingEnvironmentpressure".

Specified by:

getValue in interface Unit

getUnit

public UnitsPressure getUnit()

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

Specified by:

getUnit in interface Unit

setValue

public void setValue(double value)

Specified by:

setValue in interface Unit

setUnit

public void setUnit(UnitsPressure 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