omero.gateway.model

Class FilterData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.FilterData

public class FilterData
extends DataObject

Object hosting a filter.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
FilterData(omero.model.Filter filter) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Integer	getCutIn() Deprecated. Replaced by getCutIn(UnitsLength)
omero.model.Length	getCutIn(omero.model.enums.UnitsLength unit) Returns the cut in value or null.
Integer	getCutInTolerance() Deprecated. Replaced by getCutInTolerance(UnitsLength)
omero.model.Length	getCutInTolerance(omero.model.enums.UnitsLength unit) Returns the cut in tolerance value or null.
Integer	getCutOut() Deprecated. Replaced by getCutOut(UnitsLength)
omero.model.Length	getCutOut(omero.model.enums.UnitsLength unit) Returns the cut out value or null.
Integer	getCutOutTolerance() Deprecated. Replaced by getCutOutTolerance(UnitsLength)
omero.model.Length	getCutOutTolerance(omero.model.enums.UnitsLength unit) Returns the cut out tolerance value or null.
String	getFilterWheel() Returns the wheel.
String	getLotNumber() Returns the lot number.
String	getManufacturer() Returns the manufacturer.
String	getModel() Returns the model.
String	getSerialNumber() Returns the serial number.
Double	getTransmittance() Returns the cut out tolerance value or -1.
String	getType() Returns the type.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterData

public FilterData(omero.model.Filter filter)

Creates a new instance.

Parameters:

filter - The filter to host. Mustn't be null.

Method Detail

getCutIn

public omero.model.Length getCutIn(omero.model.enums.UnitsLength unit)
                            throws BigResult

Returns the cut in value or null.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getCutIn

@Deprecated
public Integer getCutIn()

Deprecated. Replaced by getCutIn(UnitsLength)

Returns the cut in value or null.

Returns:

See above.

getCutInTolerance

public omero.model.Length getCutInTolerance(omero.model.enums.UnitsLength unit)
                                     throws BigResult

Returns the cut in tolerance value or null.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getCutInTolerance

@Deprecated
public Integer getCutInTolerance()

Deprecated. Replaced by getCutInTolerance(UnitsLength)

Returns the cut in tolerance value or null.

Returns:

See above.

getCutOut

public omero.model.Length getCutOut(omero.model.enums.UnitsLength unit)
                             throws BigResult

Returns the cut out value or null.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getCutOut

@Deprecated
public Integer getCutOut()

Deprecated. Replaced by getCutOut(UnitsLength)

Returns the cut out value or null.

Returns:

See above.

getCutOutTolerance

public omero.model.Length getCutOutTolerance(omero.model.enums.UnitsLength unit)
                                      throws BigResult

Returns the cut out tolerance value or null.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getCutOutTolerance

@Deprecated
public Integer getCutOutTolerance()

Deprecated. Replaced by getCutOutTolerance(UnitsLength)

Returns the cut out tolerance value or null.

Returns:

See above.

getTransmittance

public Double getTransmittance()

Returns the cut out tolerance value or -1.

Returns:

See above.

getManufacturer

public String getManufacturer()

Returns the manufacturer.

Returns:

See above.

getModel

public String getModel()

Returns the model.

Returns:

See above.

getLotNumber

public String getLotNumber()

Returns the lot number.

Returns:

See above.

getSerialNumber

public String getSerialNumber()

Returns the serial number.

Returns:

See above.

getType

public String getType()

Returns the type. One out of a predefined list.

Returns:

See above.

getFilterWheel

public String getFilterWheel()

Returns the wheel.

Returns:

See above.