ome.model.units

Class Frequency

java.lang.Object

ome.model.units.Frequency

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

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

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

Method Summary

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

Frequency

@Deprecated
public Frequency()

Deprecated.

no-arg constructor to keep Hibernate happy.

Frequency

public Frequency(double d,
                 String u)

Frequency

public Frequency(double d,
                 UnitsFrequency u)

Frequency

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

Frequency

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

Method Detail

makeFrequencyUnitXML

public static ome.xml.model.enums.UnitsFrequency makeFrequencyUnitXML(String unit)

makeFrequencyXML

public static ome.units.quantity.Frequency makeFrequencyXML(double d,
                                                            String unit)

convertFrequency

public static ome.units.quantity.Frequency convertFrequency(Frequency 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.

convertFrequency

public static Frequency convertFrequency(Frequency value,
                                         ome.units.unit.Unit<ome.units.quantity.Frequency> ul)

convertFrequency

public static Frequency convertFrequency(Frequency 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, detectorSettings.getReadoutrate() which is of type Frequency will be stored in a column "detectorSettingsreadOutRate".

Specified by:

getValue in interface Unit

getUnit

public UnitsFrequency getUnit()

Many-to-one field ome.model.units.Frequency.unit (ome.model.enums.UnitsFrequency). These values are stored in a column suffixed by "Unit". Whereas value for physicalSizeX will be stored as "detectorSettings.readOutRate", the unit enum will be stored as "detectorSettings.readOutRateUnit".

Specified by:

getUnit in interface Unit

setValue

public void setValue(double value)

Specified by:

setValue in interface Unit

setUnit

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