ome.model.units

Class Time

java.lang.Object

ome.model.units.Time

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

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

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

Method Summary

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

Time

@Deprecated
public Time()

Deprecated.

no-arg constructor to keep Hibernate happy.

Time

public Time(double d,
            String u)

Time

public Time(double d,
            UnitsTime u)

Time

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

Time

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

Method Detail

makeTimeUnitXML

public static ome.xml.model.enums.UnitsTime makeTimeUnitXML(String unit)

makeTimeXML

public static ome.units.quantity.Time makeTimeXML(double d,
                                                  String unit)

convertTime

public static ome.units.quantity.Time convertTime(Time 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.

convertTime

public static Time convertTime(Time value,
                               ome.units.unit.Unit<ome.units.quantity.Time> ul)

convertTime

public static Time convertTime(Time 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, planeInfo.getExposuretime() which is of type Time will be stored in a column "planeInfoexposureTime".

Specified by:

getValue in interface Unit

getUnit

public UnitsTime getUnit()

Many-to-one field ome.model.units.Time.unit (ome.model.enums.UnitsTime). These values are stored in a column suffixed by "Unit". Whereas value for physicalSizeX will be stored as "planeInfo.exposureTime", the unit enum will be stored as "planeInfo.exposureTimeUnit".

Specified by:

getUnit in interface Unit

setValue

public void setValue(double value)

Specified by:

setValue in interface Unit

setUnit

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