Package fr.igred.omero.repository

Class WellWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

fr.igred.omero.AnnotatableWrapper<T>

fr.igred.omero.repository.GenericRepositoryObjectWrapper<WellData>

fr.igred.omero.repository.WellWrapper

public class WellWrapper
extends GenericRepositoryObjectWrapper<WellData>

Class containing a WellData object.

Wraps function calls to the WellData contained.

Nested Class Summary

Nested classes/interfaces inherited from class fr.igred.omero.repository.GenericRepositoryObjectWrapper

GenericRepositoryObjectWrapper.ReplacePolicy

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ANNOTATION_LINK	Annotation link name for this type of object

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
WellWrapper(WellData well)	Constructor of the class WellWrapper.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	annotationLinkType()	Returns the type of annotation link for this object.
WellData	asWellData()	Deprecated. Returns the WellData contained.
int	getAlpha()	Returns the alpha component of the color associated to the well, or -1.
int	getBlue()	Returns the blue component of the color associated to the well, or -1.
java.lang.Integer	getColumn()	Returns the column used to indicate the location of the well on the grid.
java.lang.String	getDescription()	Gets the object description
int	getGreen()	Returns the green component of the color associated to the well, or -1.
java.util.List<ImageWrapper>	getImages()	Retrieves the images contained in this well.
java.lang.String	getName()	Gets the object name.
PlateWrapper	getPlate()	Returns the plate containing this Well.
java.util.List<PlateAcquisitionWrapper>	getPlateAcquisitions(Client client)	Refreshes this well and returns the plate acquisitions linked to it.
int	getRed()	Returns the red component of the color associated to the well, or -1.
java.lang.Integer	getRow()	Returns the row used to indicate the location of the well on the grid.
java.util.List<ScreenWrapper>	getScreens(Client client)	Refreshes this well and retrieves the screens containing it.
java.lang.String	getStatus()	Returns the status of the well.
java.util.List<WellSampleWrapper>	getWellSamples()	Returns the well samples linked to the well.
java.lang.String	getWellType()	Returns a human-readable identifier for the screening status e.g.
void	refresh(Client client)	Reloads the well from OMERO.
void	setAlpha(java.lang.Integer alpha)	Sets the alpha component of the color associated to the well.
void	setBlue(java.lang.Integer blue)	Sets the blue component of the color associated to the well.
void	setGreen(java.lang.Integer green)	Sets the green component of the color associated to the well.
void	setRed(java.lang.Integer red)	Sets the red component of the color associated to the well.
void	setStatus(java.lang.String status)	Sets the status of the well.
void	setWellType(java.lang.String type)	Sets a human-readable identifier for the screening status e.g.

Methods inherited from class fr.igred.omero.repository.GenericRepositoryObjectWrapper

copyAnnotationLinks, importImage, importImages

Methods inherited from class fr.igred.omero.AnnotatableWrapper

addAndReplaceFile, addAndReplaceFile, addAndReplaceTable, addAndReplaceTable, addFile, addFileAnnotation, addKeyValuePair, addMapAnnotation, addPairKeyValue, addTable, addTag, addTag, addTag, addTags, addTags, copyAnnotationLinks, getAnnotations, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getMyRating, getTable, getTables, getTags, getValue, isLinked, link, link, linkIfNotLinked, rate, removeLink, unlink

Methods inherited from class fr.igred.omero.GenericObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, flatten, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATION_LINK

public static final java.lang.String ANNOTATION_LINK

Annotation link name for this type of object

See Also:

Constant Field Values

Constructor Detail

WellWrapper

public WellWrapper(WellData well)

Constructor of the class WellWrapper.

Parameters:

well - The WellData contained in the WellWrapper.

Method Detail

annotationLinkType

protected java.lang.String annotationLinkType()

Returns the type of annotation link for this object.

Specified by:

annotationLinkType in class AnnotatableWrapper<WellData>

Returns:

See above.

getName

public java.lang.String getName()

Gets the object name.

Specified by:

getName in class GenericRepositoryObjectWrapper<WellData>

Returns:

See above.

getDescription

public java.lang.String getDescription()

Gets the object description

Specified by:

getDescription in class GenericRepositoryObjectWrapper<WellData>

Returns:

See above.

asWellData

@Deprecated
public WellData asWellData()

Deprecated.

Returns the WellData contained. Use GenericObjectWrapper.asDataObject() instead.

Returns:

See above.

getWellSamples

public java.util.List<WellSampleWrapper> getWellSamples()

Returns the well samples linked to the well.

Returns:

See above.

getScreens

public java.util.List<ScreenWrapper> getScreens(Client client)
                                         throws ServiceException,
                                                AccessException,
                                                java.util.concurrent.ExecutionException,
                                                OMEROServerError

Refreshes this well and retrieves the screens containing it.

Parameters:

client - The client handling the connection.

Returns:

See above

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.

OMEROServerError - Server error.

getPlate

public PlateWrapper getPlate()

Returns the plate containing this Well.

Returns:

See above.

getPlateAcquisitions

public java.util.List<PlateAcquisitionWrapper> getPlateAcquisitions(Client client)
                                                             throws ServiceException,
                                                                    AccessException,
                                                                    java.util.concurrent.ExecutionException

Refreshes this well and returns the plate acquisitions linked to it.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.

getImages

public java.util.List<ImageWrapper> getImages()

Retrieves the images contained in this well.

Returns:

See above.

getColumn

public java.lang.Integer getColumn()

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

Returns:

See above.

getRow

public java.lang.Integer getRow()

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

Returns:

See above.

getStatus

public java.lang.String getStatus()

Returns the status of the well.

Returns:

See above.

setStatus

public void setStatus(java.lang.String status)

Sets the status of the well.

Parameters:

status - The status of the well.

getWellType

public java.lang.String getWellType()

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

Returns:

See above.

setWellType

public void setWellType(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.Integer alpha)

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

Parameters:

alpha - The value to set.

refresh

public void refresh(Client client)
             throws ServiceException,
                    AccessException,
                    java.util.concurrent.ExecutionException

Reloads the well from OMERO.

Parameters:

client - The client handling the connection.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.