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 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected 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`.
`Integer`	`getColumn()`	Returns the column used to indicate the location of the well on the grid.
`String`	`getDescription()`	Gets the object description
`int`	`getGreen()`	Returns the green component of the color associated to the well, or `-1`.
`List<ImageWrapper>`	`getImages()`	Retrieves the images contained in this well.
`String`	`getName()`	Gets the object name.
`PlateWrapper`	`getPlate()`	Returns the plate containing this Well.
`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`.
`Integer`	`getRow()`	Returns the row used to indicate the location of the well on the grid.
`List<ScreenWrapper>`	`getScreens(Client client)`	Refreshes this well and retrieves the screens containing it.
`String`	`getStatus()`	Returns the status of the well.
`List<WellSampleWrapper>`	`getWellSamples()`	Returns the well samples linked to the well.
`String`	`getWellType()`	Returns a human-readable identifier for the screening status e.g.
`void`	`refresh(Client client)`	Reloads the well from OMERO.
`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`	`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`	`setWellType(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 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 String annotationLinkType()
```
    Returns the type of annotation link for this object.
    
    Specified by:
    
    annotationLinkType in class AnnotatableWrapper<WellData>
    
    Returns:
    
    See above.
  - getName
```
public String getName()
```
    Gets the object name.
    
    Specified by:
    
    getName in class GenericRepositoryObjectWrapper<WellData>
    
    Returns:
    
    See above.
  - getDescription
```
public 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 List<WellSampleWrapper> getWellSamples()
```
    Returns the well samples linked to the well.
    
    Returns:
    
    See above.
  - getScreens
```
public List<ScreenWrapper> getScreens(Client client)
                               throws ServiceException,
                                      AccessException,
                                      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.
    
    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 List<PlateAcquisitionWrapper> getPlateAcquisitions(Client client)
                                                   throws ServiceException,
                                                          AccessException,
                                                          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.
    
    ExecutionException - A Facility can't be retrieved or instantiated.
  - getImages
```
public List<ImageWrapper> getImages()
```
    Retrieves the images contained in this well.
    
    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.
  - getStatus
```
public String getStatus()
```
    Returns the status of the well.
    
    Returns:
    
    See above.
  - setStatus
```
public void setStatus(String status)
```
    Sets the status of the well.
    
    Parameters:
    
    status - The status of the well.
  - 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.
  - refresh
```
public void refresh(Client client)
             throws ServiceException,
                    AccessException,
                    ExecutionException
```
    Reloads the well from OMERO.
    
    Parameters:
    
    client - The client handling the connection.
    
    Throws:
    
    ServiceException - Cannot connect to OMERO.
    
    AccessException - Cannot access data.
    
    ExecutionException - A Facility can't be retrieved or instantiated.

Class WellWrapper

Nested Class Summary

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

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

Constructor Summary

Method Summary

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

Methods inherited from class fr.igred.omero.AnnotatableWrapper

Methods inherited from class fr.igred.omero.GenericObjectWrapper

Methods inherited from class java.lang.Object

Field Detail

ANNOTATION_LINK

Constructor Detail

WellWrapper

Method Detail

annotationLinkType

getName

getDescription

asWellData

getWellSamples

getScreens

getPlate

getPlateAcquisitions

getImages

getColumn

getRow

getStatus

setStatus

getWellType

setWellType

getRed

setRed

getGreen

setGreen

getBlue

setBlue

getAlpha

setAlpha

refresh