Package ome.model.units

Class Frequency

  • All Implemented Interfaces:
    java.io.Serializable, Primitive, Unit, Filterable
    @Embeddable
public class Frequency
extends java.lang.Object
implements java.io.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

    • Constructor Detail

      • Frequency

        @Deprecated
public Frequency()
        Deprecated.
        no-arg constructor to keep Hibernate happy.

      • Frequency

        public Frequency​(double d,
                 java.lang.String 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​(java.lang.String unit)

      • makeFrequencyXML

        public static ome.units.quantity.Frequency makeFrequencyXML​(double d,
                                                            java.lang.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,
                                         java.lang.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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object