Package fr.igred.omero.repository

Class PlateAcquisitionWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

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

fr.igred.omero.repository.PlateAcquisitionWrapper

public class PlateAcquisitionWrapper
extends GenericRepositoryObjectWrapper<PlateAcquisitionData>

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

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addTag(Client client, TagAnnotationData tagData)	Protected function.
protected String	annotationLinkType()	Returns the type of annotation link for this object
PlateAcquisitionData	asPlateAcquisitionData()
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.
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.repository.GenericRepositoryObjectWrapper

addAndReplaceFile, addAndReplaceFile, addFile, addFileAnnotation, addMapAnnotation, addPairKeyValue, addTable, addTag, addTag, addTag, addTags, addTags, copyAnnotationLinks, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getTable, getTables, getTags, getValue, removeLink, unlink

Methods inherited from class fr.igred.omero.GenericObjectWrapper

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, 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

See Also:

Constant Field Values

Constructor Detail

PlateAcquisitionWrapper

public PlateAcquisitionWrapper(PlateAcquisitionData plateAcquisition)

Constructor of the class PlateAcquisitionWrapper.

Parameters:

plateAcquisition - The plate acquisition contained in the PlateAcquisitionWrapper.

Method Detail

annotationLinkType

protected String annotationLinkType()

Returns the type of annotation link for this object

Specified by:

annotationLinkType in class GenericRepositoryObjectWrapper<PlateAcquisitionData>

Returns:

See above.

getName

public String getName()

Gets the plate acquisition name.

Specified by:

getName in class GenericRepositoryObjectWrapper<PlateAcquisitionData>

Returns:

See above.

setName

public void setName(String name)

Sets the name of the plate acquisition.

Parameters:

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

Throws:

IllegalArgumentException - If the name is null.

asPlateAcquisitionData

public PlateAcquisitionData asPlateAcquisitionData()

Returns:

the PlateAcquisitionData contained.

getDescription

public String getDescription()

Gets the plate acquisition description

Specified by:

getDescription in class GenericRepositoryObjectWrapper<PlateAcquisitionData>

Returns:

See above.

setDescription

public void setDescription(String description)

Sets the description of the plate acquisition.

Parameters:

description - The description of the plate acquisition.

addTag

protected void addTag(Client client,
                      TagAnnotationData tagData)
               throws ServiceException,
                      AccessException,
                      ExecutionException

Protected function. Adds a tag to the object in OMERO, if possible.

Overrides:

addTag in class GenericRepositoryObjectWrapper<PlateAcquisitionData>

Parameters:

client - The client handling the connection.

tagData - Tag to be added.

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.

Returns:

See above.

getRefPlateId

public long getRefPlateId()

Returns the id of the plate of reference.

Returns:

See above.

setRefPlateId

public void setRefPlateId(long refPlateId)

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

Parameters:

refPlateId - The value to set.

getStartTime

public Timestamp getStartTime()

Returns the time when the first image was collected.

Returns:

See above.

getEndTime

public Timestamp getEndTime()

Returns the time when the last image was collected.

Returns:

See above.

getMaximumFieldCount

public int getMaximumFieldCount()

Returns the maximum number of fields in any well.

Returns:

See above.