omero.model

Class FrequencyI

java.lang.Object

Ice.ObjectImpl

omero.model.Frequency

omero.model.FrequencyI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _FrequencyOperations, _FrequencyOperationsNC

public class FrequencyI
extends Frequency
implements ome.model.ModelBased

Blitz wrapper around the Frequency class. Like Details and Permissions, this object is embedded into other objects and does not have a full life cycle of its own.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Ice.ObjectFactory	Factory

Fields inherited from class omero.model.Frequency

__ids, unit, value

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
FrequencyI()
FrequencyI(double d, ome.units.unit.Unit<ome.units.quantity.Frequency> unit)
FrequencyI(double d, UnitsFrequency unit)
FrequencyI(double d, ome.model.enums.UnitsFrequency ul) Copy constructor that converts the given Frequency based on the given ome.model enum
FrequencyI(ome.units.quantity.Frequency value) Convert a Bio-Formats Length to an OMERO Length.
FrequencyI(Frequency value, java.lang.String target) Copy constructor that converts the given Frequency based on the given enum string.
FrequencyI(Frequency value, ome.units.unit.Unit<ome.units.quantity.Frequency> ul) Copy constructor that converts the given Frequency based on the given ome-xml enum
FrequencyI(Frequency value, UnitsFrequency target) Copy constructor that converts between units if possible.

Method Summary

Modifier and Type	Method and Description
static ome.units.quantity.Frequency	convert(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.
Frequency	copy(Ice.Current ignore)
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper mapper)
boolean	equals(java.lang.Object obj)
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper mapper)
java.lang.String	getSymbol(Ice.Current current) Returns the possibly unicode representation of the ""unit"" value for display.
UnitsFrequency	getUnit(Ice.Current current) UnitsFrequency instance which is an IObject meaning that its ID is sufficient for identifying equality.
double	getValue(Ice.Current current) Actual value for this unit-based field.
int	hashCode()
static java.lang.String	lookupSymbol(UnitsFrequency unit)
static Ice.ObjectFactory	makeFactory(client client)
static ome.units.quantity.Frequency	makeXMLQuantity(double d, java.lang.String unit)
static ome.xml.model.enums.UnitsFrequency	makeXMLUnit(java.lang.String unit)
void	setUnit(UnitsFrequency unit, Ice.Current current)
void	setValue(double value, Ice.Current current)
java.lang.String	toString()

Methods inherited from class omero.model.Frequency

___copy, ___getSymbol, ___getUnit, ___getValue, ___setUnit, ___setValue, __dispatch, __readImpl, __writeImpl, clone, copy, getSymbol, getUnit, getValue, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setUnit, setValue

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Factory

public static final Ice.ObjectFactory Factory

Constructor Detail

FrequencyI

public FrequencyI()

FrequencyI

public FrequencyI(double d,
                  UnitsFrequency unit)

FrequencyI

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

FrequencyI

public FrequencyI(Frequency value,
                  ome.units.unit.Unit<ome.units.quantity.Frequency> ul)
           throws ome.model.units.BigResult

Copy constructor that converts the given Frequency based on the given ome-xml enum

Throws:

ome.model.units.BigResult

FrequencyI

public FrequencyI(double d,
                  ome.model.enums.UnitsFrequency ul)

Copy constructor that converts the given Frequency based on the given ome.model enum

FrequencyI

public FrequencyI(Frequency value,
                  java.lang.String target)
           throws ome.model.units.BigResult

Copy constructor that converts the given Frequency based on the given enum string. If either the source or the target unit is null or if no conversion is possible between the two types (e.g. PIXELS), an IllegalArgumentException will be thrown. If the conversion results in an overflow, a BigResult will be thrown, unless the input value was already Infinite or NaN, in which case that will be the return value.

Parameters:

target - String representation of the CODE enum

Throws:

java.lang.IllegalArgumentException - if the source or target unit is null or an unconvertible type (e.g. PIXELS)

ome.model.units.BigResult - if the conversion leads to an infinite or NaN result

FrequencyI

public FrequencyI(Frequency value,
                  UnitsFrequency target)
           throws ome.model.units.BigResult

Copy constructor that converts between units if possible.

Parameters:

target - unit that is desired. non-null.

Throws:

ome.model.units.BigResult

FrequencyI

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

Convert a Bio-Formats Length to an OMERO Length.

Method Detail

lookupSymbol

public static java.lang.String lookupSymbol(UnitsFrequency unit)

makeFactory

public static final Ice.ObjectFactory makeFactory(client client)

makeXMLUnit

public static ome.xml.model.enums.UnitsFrequency makeXMLUnit(java.lang.String unit)

makeXMLQuantity

public static ome.units.quantity.Frequency makeXMLQuantity(double d,
                                                           java.lang.String unit)

convert

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

getValue

public double getValue(Ice.Current current)

Description copied from interface: _FrequencyOperations

Actual value for this unit-based field. The interpretation of the value is only possible along with the UnitsFrequency enum.

Specified by:

getValue in interface _FrequencyOperations

Parameters:

current - The Current object for the invocation.

setValue

public void setValue(double value,
                     Ice.Current current)

Specified by:

setValue in interface _FrequencyOperations

getUnit

public UnitsFrequency getUnit(Ice.Current current)

Description copied from interface: _FrequencyOperations

UnitsFrequency instance which is an IObject meaning that its ID is sufficient for identifying equality.

Specified by:

getUnit in interface _FrequencyOperations

Parameters:

current - The Current object for the invocation.

setUnit

public void setUnit(UnitsFrequency unit,
                    Ice.Current current)

Specified by:

setUnit in interface _FrequencyOperations

getSymbol

public java.lang.String getSymbol(Ice.Current current)

Description copied from interface: _FrequencyOperations

Returns the possibly unicode representation of the ""unit"" value for display.

Specified by:

getSymbol in interface _FrequencyOperations

Parameters:

current - The Current object for the invocation.

copy

public Frequency copy(Ice.Current ignore)

Specified by:

copy in interface _FrequencyOperations

copyObject

public void copyObject(ome.util.Filterable model,
                       ome.util.ModelMapper mapper)

Specified by:

copyObject in interface ome.model.ModelBased

fillObject

public ome.util.Filterable fillObject(ome.util.ReverseModelMapper mapper)

Specified by:

fillObject in interface ome.model.ModelBased

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