pojos

Class WellData

java.lang.Object

pojos.DataObject

pojos.WellData

public class WellData
extends DataObject

The data that makes up an OME Well and the Experimenter that owns this Well.

Since:

3.0-Beta3

Version:

3.0 (Internal version: $Revision: $Date: $)

Author:

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

Constructor Summary

Constructors

Constructor and Description
WellData() Creates a new instance.
WellData(omero.model.Well well) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAlpha() Returns the alpha component of the color associated to the well, or -1.
Map<Long,Long>	getAnnotationsCounts() Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
int	getBlue() Returns the blue component of the color associated to the well, or -1.
Integer	getColumn() Returns the column used to indicate the location of the well on the grid.
String	getExternalDescription() Returns the external description of the well.
int	getGreen() Returns the green component of the color associated to the well, or -1.
PlateData	getPlate() Returns the plate containing this Well.
Map<Long,Long>	getReagentsCounts() Returns the number of reagents linked to the object, key: id of the user, value: number of annotation.
int	getRed() Returns the red component of the color associated to the well, or -1.
Integer	getRow() Returns the row used to indicate the location of the well on the grid.
String	getStatus() Returns the status of the well.
List<WellSampleData>	getWellSamples() Returns the well samples linked to the well.
String	getWellType() Returns a human readable identifier for the screening status e.g. empty, positive control, etc.
void	setAlpha(Integer alpha) Sets the alpha component of the color associated to the well.
void	setBlue(Integer blue) Sets the blue component of the color associated to the well.
void	setExternalDescription(String description) Sets the external description of the well.
void	setGreen(Integer green) Sets the green component of the color associated to the well.
void	setRed(Integer red) Sets the red component of the color associated to the well.
void	setStatus(String status) Sets the status of the well.
void	setWellSamples(List<WellSampleData> value) Sets the well samples linked to the well.
void	setWellType(String type) Sets a human readable identifier for the screening status e.g. empty, positive control, etc.

Methods inherited from class pojos.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, 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

WellData

public WellData()

Creates a new instance.

WellData

public WellData(omero.model.Well well)

Creates a new instance.

Parameters:

well - Back pointer to the Well model object. Mustn't be null.

Throws:

IllegalArgumentException - If the object is null.

Method Detail

getExternalDescription

public String getExternalDescription()

Returns the external description of the well.

Returns:

See above.

getStatus

public String getStatus()

Returns the status of the well.

Returns:

See above.

getWellType

public String getWellType()

Returns a human readable identifier for the screening status e.g. empty, positive control, etc.

Returns:

See above.

setWellType

public void setWellType(String type)

Sets a human readable identifier for the screening status e.g. empty, positive control, etc.

Parameters:

type - The value to set.

getRed

public int getRed()

Returns the red component of the color associated to the well, or -1.

Returns:

See above.

setRed

public void setRed(Integer red)

Sets the red component of the color associated to the well.

Parameters:

red - The value to set.

getGreen

public int getGreen()

Returns the green component of the color associated to the well, or -1.

Returns:

See above.

setGreen

public void setGreen(Integer green)

Sets the green component of the color associated to the well.

Parameters:

green - The value to set.

getBlue

public int getBlue()

Returns the blue component of the color associated to the well, or -1.

Returns:

See above.

setBlue

public void setBlue(Integer blue)

Sets the blue component of the color associated to the well.

Parameters:

blue - The value to set.

getAlpha

public int getAlpha()

Returns the alpha component of the color associated to the well, or -1.

Returns:

See above.

setAlpha

public void setAlpha(Integer alpha)

Sets the alpha component of the color associated to the well.

Parameters:

alpha - The value to set.

setExternalDescription

public void setExternalDescription(String description)

Sets the external description of the well.

Parameters:

description - The description of the well.

setStatus

public void setStatus(String status)

Sets the status of the well.

Parameters:

status - The status of the well.

getAnnotationsCounts

public Map<Long,Long> getAnnotationsCounts()

Returns the number of annotations linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.

Returns:

See above.

getReagentsCounts

public Map<Long,Long> getReagentsCounts()

Returns the number of reagents linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.

Returns:

See above.

getColumn

public Integer getColumn()

Returns the column used to indicate the location of the well on the grid.

Returns:

See above.

getRow

public Integer getRow()

Returns the row used to indicate the location of the well on the grid.

Returns:

See above.

getPlate

public PlateData getPlate()

Returns the plate containing this Well.

Returns:

See above.

getWellSamples

public List<WellSampleData> getWellSamples()

Returns the well samples linked to the well.

Returns:

See above.

setWellSamples

public void setWellSamples(List<WellSampleData> value)

Sets the well samples linked to the well.

Parameters:

value - The set of well samples.