ome.model.units

Class Length

java.lang.Object

ome.model.units.Length

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

@Embeddable
public class Length
extends Object
implements 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 and Description
static String	UNIT
static String	VALUE

Constructor Summary

Constructors

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

Method Summary

Methods

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

Length

@Deprecated
public Length()

Deprecated.

no-arg constructor to keep Hibernate happy.

Length

public Length(double d,
      String u)

Length

public Length(double d,
      UnitsLength 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(String unit)

makeLengthXML

public static ome.units.quantity.Length makeLengthXML(double d,
                                      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,
                   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

setUnit

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