Package fr.igred.omero.repository

Class WellSampleWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<WellSampleData>

fr.igred.omero.repository.WellSampleWrapper

public class WellSampleWrapper
extends GenericObjectWrapper<WellSampleData>

Class containing a WellSampleData object.

Wraps function calls to the WellSampleData contained.

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
WellSampleWrapper(WellSampleData wellSample)	Constructor of the class WellSampleWrapper.

Method Summary

Modifier and Type	Method	Description
WellSampleData	asWellSampleData()	Deprecated. Returns the WellSampleData contained.
ImageWrapper	getImage()	Returns the image related to that sample if any.
List<PlateAcquisitionWrapper>	getPlateAcquisitions(Client client)	Returns the plate acquisitions linked to the parent Well.
List<PlateWrapper>	getPlates(Client client)	Returns the plates containing the parent Well.
Length	getPositionX(omero.model.enums.UnitsLength unit)	Returns the position X.
Length	getPositionY(omero.model.enums.UnitsLength unit)	Returns the position Y.
List<ScreenWrapper>	getScreens(Client client)	Returns the screens containing the parent Well.
long	getStartTime()	Returns the time at which the field was acquired.
WellWrapper	getWell(Client client)	Retrieves the well containing this well sample
void	setImage(ImageWrapper image)	Sets the image linked to this well sample.

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

Constructor Detail

WellSampleWrapper

public WellSampleWrapper(WellSampleData wellSample)

Constructor of the class WellSampleWrapper.

Parameters:

wellSample - The WellSampleData to wrap in the WellSampleWrapper.

Method Detail

asWellSampleData

@Deprecated
public WellSampleData asWellSampleData()

Deprecated.

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

Returns:

See above.

getScreens

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

Returns the screens containing the parent Well.

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.

getPlates

public List<PlateWrapper> getPlates(Client client)
                             throws ServiceException,
                                    AccessException,
                                    ExecutionException

Returns the plates containing the parent Well.

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.

getPlateAcquisitions

public List<PlateAcquisitionWrapper> getPlateAcquisitions(Client client)
                                                   throws ServiceException,
                                                          AccessException,
                                                          ExecutionException

Returns the plate acquisitions linked to the parent Well.

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.

getWell

public WellWrapper getWell(Client client)
                    throws AccessException,
                           ServiceException,
                           ExecutionException

Retrieves the well containing this well sample

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.

getImage

public ImageWrapper getImage()

Returns the image related to that sample if any.

Returns:

See above.

setImage

public void setImage(ImageWrapper image)

Sets the image linked to this well sample.

Parameters:

image - The image to set.

getPositionX

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

Returns the position X.

Parameters:

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

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getPositionY

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

Returns the position Y.

Parameters:

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

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getStartTime

public long getStartTime()

Returns the time at which the field was acquired.

Returns:

See above.