Package ome.model.units

Class Length

  • All Implemented Interfaces:
    java.io.Serializable, Primitive, Unit, Filterable
    @Embeddable
public class Length
extends java.lang.Object
implements java.io.Serializable, Filterable, Unit
    class storing both a Length and a unit for that Length (e.g. m, in, ly, etc.) encapsulated in a UnitsLength instance. As also described in the remoting definition (.ice) for Length, 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 Description
      static java.lang.String UNIT  
      static java.lang.String VALUE  

    • Constructor Summary

      Constructors 
      Constructor Description
      Length()
      Deprecated.
      Length​(double d, java.lang.String u)  
      Length​(double d, UnitsLength u)  
      Length​(double d, ome.units.unit.Unit<ome.units.quantity.Length> unit)  
      Length​(ome.units.quantity.Length value)  

    • Constructor Detail

      • Length

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

      • Length

        public Length​(double d,
              java.lang.String u)

      • Length

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

      • Length

        public Length​(ome.units.quantity.Length value)

    • Method Detail

      • makeLengthUnitXML

        public static ome.xml.model.enums.UnitsLength makeLengthUnitXML​(java.lang.String unit)

      • makeLengthXML

        public static ome.units.quantity.Length makeLengthXML​(double d,
                                                      java.lang.String unit)

      • convertLength

        public static ome.units.quantity.Length convertLength​(Length 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.

      • convertLength

        public static Length convertLength​(Length value,
                                   ome.units.unit.Unit<ome.units.quantity.Length> ul)

      • convertLength

        public static Length convertLength​(Length 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, pixels.getPhysicalsizex() which is of type Length will be stored in a column "pixelsphysicalSizeX".
        Specified by:
        getValue in interface Unit

      • getUnit

        public UnitsLength getUnit()
        Many-to-one field ome.model.units.Length.unit (ome.model.enums.UnitsLength). These values are stored in a column suffixed by "Unit". Whereas value for physicalSizeX will be stored as "pixels.physicalSizeX", the unit enum will be stored as "pixels.physicalSizeXUnit".
        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