omero.gateway.model

Class PlateAcquisitionData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.PlateAcquisitionData

public class PlateAcquisitionData
extends DataObject

The data that makes up an OME PlateAcquisition.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
PlateAcquisitionData() Creates a new instance.
PlateAcquisitionData(omero.model.PlateAcquisition value) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<Long,Long>	getAnnotationsCounts() Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
String	getDescription() Returns the description of the plate acquisition.
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() Returns the name of the plate acquisition.
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 name of the acquisition.
void	setName(String name) Sets the name of the acquisition.
void	setRefPlateId(long refPlateId) Sets the id of the plate this plate acquisition is for.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlateAcquisitionData

public PlateAcquisitionData()

Creates a new instance.

PlateAcquisitionData

public PlateAcquisitionData(omero.model.PlateAcquisition value)

Creates a new instance.

Parameters:

value - Back pointer to the PlateAcquisition model object. Mustn't be null.

Method Detail

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.

getName

public String getName()

Returns the name of the plate acquisition.

Returns:

See above.

getDescription

public String getDescription()

Returns the description of the plate acquisition.

Returns:

See above.

setName

public void setName(String name)

Sets the name of the acquisition.

Parameters:

name - The value to set.

setDescription

public void setDescription(String description)

Sets the name of the acquisition.

Parameters:

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

getLabel

public String getLabel()

Returns the label associated to the plate acquisition.

Returns:

See above.

getMaximumFieldCount

public int getMaximumFieldCount()

Returns the maximum number of fields in any well.

Returns:

See above.

getAnnotationsCounts

public Map<Long,Long> getAnnotationsCounts()

Returns the number of annotations linked to the object, key: id of the user, value: number of annotation. The map may be null if no annotation.

Returns:

See above.