fr.igred.omero.screen

Class PlateAcquisitionWrapper

java.lang.Object

fr.igred.omero.ObjectWrapper<T>

fr.igred.omero.AnnotatableWrapper<PlateAcquisitionData>

fr.igred.omero.screen.PlateAcquisitionWrapper

All Implemented Interfaces:

Annotatable, RemoteObject, RepositoryObject, PlateAcquisition

public class PlateAcquisitionWrapper
extends AnnotatableWrapper<PlateAcquisitionData>
implements PlateAcquisition

Class containing a PlateAcquisitionData object.

Wraps function calls to the PlateAcquisitionData contained.

Field Summary

Fields

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

Fields inherited from class fr.igred.omero.ObjectWrapper

data

Constructor Summary

Constructors

Constructor and Description
PlateAcquisitionWrapper(PlateAcquisitionData plateAcquisition) Constructor of the class PlateAcquisitionWrapper.

Method Summary

Modifier and Type	Method and Description
protected String	annotationLinkType() Returns the type of annotation link for this object.
String	getDescription() Gets the plate acquisition description
Timestamp	getEndTime() Returns the time when the last image was collected.
String	getLabel() Returns the label associated to the plate acquisition.
int	getMaximumFieldCount() Returns the maximum number of fields in any well.
String	getName() Gets the plate acquisition name.
long	getRefPlateId() Returns the id of the plate of reference.
Timestamp	getStartTime() Returns the time when the first image was collected.
List<WellSample>	getWellSamples() Retrieves the well samples for this plate acquisition.
List<WellSample>	getWellSamples(Browser browser) Retrieves the well samples for this plate acquisition from OMERO and updates the object.
void	reload(Browser browser) Reloads the plate acquisition from OMERO.
void	setDescription(String description) Sets the description of the plate acquisition.
void	setName(String name) Sets the name of the plate acquisition.
void	setRefPlateId(long refPlateId) Sets the id of the plate this plate acquisition is for.

Methods inherited from class fr.igred.omero.AnnotatableWrapper

addAndReplaceFile, addAndReplaceTable, addKeyValuePair, addTag, addTag, getAnnotations, getFileAnnotations, getMapAnnotations, getMyRating, getTable, getTags, rate, removeLink, unlink

Methods inherited from class fr.igred.omero.ObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, getUpdated, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.igred.omero.screen.PlateAcquisition

asDataObject, getChildren, getImages, getImages, getParents, getPlates, getScreens, getWells, link

Methods inherited from interface fr.igred.omero.Annotatable

addAndReplaceFile, addAndReplaceFile, addAndReplaceTable, addAndReplaceTable, addFile, addKeyValuePair, addTable, addTag, addTag, addTags, copyAnnotationLinks, getAnnotationData, getAnnotations, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getMyRating, getTable, getTables, getTags, getValues, isLinked, link, link, linkIfNotLinked, rate, unlink

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

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

PlateAcquisitionWrapper

public PlateAcquisitionWrapper(PlateAcquisitionData plateAcquisition)

Constructor of the class PlateAcquisitionWrapper.

Parameters:

plateAcquisition - The PlateAcquisitionData to wrap in the PlateAcquisitionWrapper.

Method Detail

annotationLinkType

protected String annotationLinkType()

Returns the type of annotation link for this object.

Specified by:

annotationLinkType in class AnnotatableWrapper<PlateAcquisitionData>

Returns:

See above.

getName

public String getName()

Gets the plate acquisition name.

Specified by:

getName in interface RepositoryObject

Returns:

See above.

setName

public void setName(String name)

Sets the name of the plate acquisition.

Specified by:

setName in interface PlateAcquisition

Parameters:

name - The name of the plate acquisition. Mustn't be null.

Throws:

IllegalArgumentException - If the name is null.

getDescription

public String getDescription()

Gets the plate acquisition description

Specified by:

getDescription in interface RepositoryObject

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the plate acquisition.

Specified by:

setDescription in interface PlateAcquisition

Parameters:

description - The description of the plate acquisition.

getWellSamples

public List<WellSample> getWellSamples()

Retrieves the well samples for this plate acquisition.

Specified by:

getWellSamples in interface PlateAcquisition

Returns:

See above.

getWellSamples

public List<WellSample> getWellSamples(Browser browser)
                                throws AccessException,
                                       ServiceException,
                                       ExecutionException

Retrieves the well samples for this plate acquisition from OMERO and updates the object.

Specified by:

getWellSamples in interface PlateAcquisition

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getLabel

public String getLabel()

Returns the label associated to the plate acquisition.

Specified by:

getLabel in interface PlateAcquisition

Returns:

See above.

getRefPlateId

public long getRefPlateId()

Returns the id of the plate of reference.

Specified by:

getRefPlateId in interface PlateAcquisition

Returns:

See above.

setRefPlateId

public void setRefPlateId(long refPlateId)

Sets the id of the plate this plate acquisition is for.

Specified by:

setRefPlateId in interface PlateAcquisition

Parameters:

refPlateId - The value to set.

getStartTime

public Timestamp getStartTime()

Returns the time when the first image was collected.

Specified by:

getStartTime in interface PlateAcquisition

Returns:

See above.

getEndTime

public Timestamp getEndTime()

Returns the time when the last image was collected.

Specified by:

getEndTime in interface PlateAcquisition

Returns:

See above.

getMaximumFieldCount

public int getMaximumFieldCount()

Returns the maximum number of fields in any well.

Specified by:

getMaximumFieldCount in interface PlateAcquisition

Returns:

See above.

reload

public void reload(Browser browser)
            throws ServiceException,
                   AccessException,
                   ExecutionException

Reloads the plate acquisition from OMERO.

Specified by:

reload in interface RepositoryObject

Specified by:

reload in interface PlateAcquisition

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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