ome.model.units

Class ElectricPotential

java.lang.Object

ome.model.units.ElectricPotential

All Implemented Interfaces:

Serializable, Primitive, Unit, Filterable

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

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

Method Summary

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

ElectricPotential

@Deprecated
public ElectricPotential()

Deprecated.

no-arg constructor to keep Hibernate happy.

ElectricPotential

public ElectricPotential(double d,
                         String u)

ElectricPotential

public ElectricPotential(double d,
                         UnitsElectricPotential u)

ElectricPotential

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

ElectricPotential

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

Method Detail

makeElectricPotentialUnitXML

public static ome.xml.model.enums.UnitsElectricPotential makeElectricPotentialUnitXML(String unit)

makeElectricPotentialXML

public static ome.units.quantity.ElectricPotential makeElectricPotentialXML(double d,
                                                                            String unit)

convertElectricPotential

public static ome.units.quantity.ElectricPotential convertElectricPotential(ElectricPotential 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.

convertElectricPotential

public static ElectricPotential convertElectricPotential(ElectricPotential value,
                                                         ome.units.unit.Unit<ome.units.quantity.ElectricPotential> ul)

convertElectricPotential

public static ElectricPotential convertElectricPotential(ElectricPotential 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.getVolatage() which is of type ElectricPotential will be stored in a column "detectorSettingsvolatage".

Specified by:

getValue in interface Unit

getUnit

public UnitsElectricPotential getUnit()

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

Specified by:

getUnit in interface Unit

setValue

public void setValue(double value)

Specified by:

setValue in interface Unit

setUnit

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