pojos
Class PlateData

java.lang.Object
  extended by pojos.DataObject
      extended by pojos.PlateData

public class PlateData
extends DataObject

The data that makes up an OME Plate along with links to its contained Well and enclosing Screen as well as the Experimenter that owns this Plate.

Since:
3.0-Beta3
Version:
3.0 (Internal version: $Revision: $Date: $)
Author:
Jean-Marie Burel      j.burel@dundee.ac.uk, Donald MacDonald      donald@lifesci.dundee.ac.uk

Field Summary
static String ANNOTATIONS
          Identifies the Plate#ANNOTATIONLINKS field.
static int ASCENDING_LETTER
          Indicates that the column or row is a letter starting from A.
static int ASCENDING_NUMBER
          Indicates that the column or row is a number starting from 1.
static int DESCENDING_LETTER
          Indicates that the column or row is a letter starting from Z or P.
static int DESCENDING_NUMBER
          Indicates that the column or row is a letter starting from 26 or 16.
static String DESCRIPTION
          Identifies the Plate#DESCRIPTION field.
static String NAME
          Identifies the Plate#NAME field.
static String SCREEN_LINKS
          Identifies the Plate#SCREENLINKS field.
static String WELLS
          Identifies the Plate#WELLS field.
 
Constructor Summary
PlateData()
          Creates a new instance.
PlateData(omero.model.Plate plate)
          Creates a new instance.
 
Method Summary
 Map<Long,Long> getAnnotationsCounts()
          Returns the number of annotations linked to the object, key: id of the user, value: number of annotation.
 int getColumnSequenceIndex()
          Returns the index indicating how to label a column.
 int getDefaultSample()
          Returns the currently selected field or 0.
 String getDescription()
          Returns the description of the plate.
 String getExternalIdentifier()
          Returns the external identifier of the plate.
 String getName()
          Returns the name of the plate.
 Set<PlateAcquisitionData> getPlateAcquisitions()
          Returns the plate acquisitions related to this plate.
 String getPlateType()
          Returns the type of plate e.g.
 int getRowSequenceIndex()
          Returns the index indicating how to label a row.
 Set<ScreenData> getScreens()
          Returns a set of screens containing the plate.
 String getStatus()
          Returns the status of the plate.
 double getWellOriginX()
          Returns the x-coordinate in 2D-space of the well.
 double getWellOriginY()
          Returns the y-coordinate in 2D-space of the well.
 void setDefaultSample(int value)
          Sets the default sample.
 void setDescription(String description)
          Sets the description of the plate.
 void setExternalIdentifier(String value)
          Sets the external identifier.
 void setName(String name)
          Sets the name of the plate.
 void setPlateAcquisition(Set<PlateAcquisitionData> value)
          Sets the plate acquisition linked to the plate.
 void setScreens(Set<ScreenData> value)
          Sets the screens containing the plate.
 void setStatus(String value)
          Sets the status.
 
Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, getCreated, getDetails, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, 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
 

Field Detail

ASCENDING_NUMBER

public static final int ASCENDING_NUMBER
Indicates that the column or row is a number starting from 1.

See Also:
Constant Field Values

ASCENDING_LETTER

public static final int ASCENDING_LETTER
Indicates that the column or row is a letter starting from A.

See Also:
Constant Field Values

DESCENDING_NUMBER

public static final int DESCENDING_NUMBER
Indicates that the column or row is a letter starting from 26 or 16.

See Also:
Constant Field Values

DESCENDING_LETTER

public static final int DESCENDING_LETTER
Indicates that the column or row is a letter starting from Z or P.

See Also:
Constant Field Values

NAME

public static final String NAME
Identifies the Plate#NAME field.

See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Identifies the Plate#DESCRIPTION field.

See Also:
Constant Field Values

WELLS

public static final String WELLS
Identifies the Plate#WELLS field.

See Also:
Constant Field Values

SCREEN_LINKS

public static final String SCREEN_LINKS
Identifies the Plate#SCREENLINKS field.

See Also:
Constant Field Values

ANNOTATIONS

public static final String ANNOTATIONS
Identifies the Plate#ANNOTATIONLINKS field.

See Also:
Constant Field Values
Constructor Detail

PlateData

public PlateData()
Creates a new instance.


PlateData

public PlateData(omero.model.Plate plate)
Creates a new instance.

Parameters:
plate - Back pointer to the Plate model object. Mustn't be null.
Throws:
IllegalArgumentException - If the object is null.
Method Detail

setName

public void setName(String name)
Sets the name of the plate.

Parameters:
name - The name of the plate. Mustn't be null.
Throws:
IllegalArgumentException - If the name is null.

getName

public String getName()
Returns the name of the plate.

Returns:
See above.

setDescription

public void setDescription(String description)
Sets the description of the plate.

Parameters:
description - The description of the plate.

getDescription

public String getDescription()
Returns the description of the plate.

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.

getScreens

public Set<ScreenData> getScreens()
Returns a set of screens containing the plate.

Returns:
See above.

setScreens

public void setScreens(Set<ScreenData> value)
Sets the screens containing the plate.

Parameters:
value - The set of screens.

getColumnSequenceIndex

public int getColumnSequenceIndex()
Returns the index indicating how to label a column.

Returns:
See above.

getRowSequenceIndex

public int getRowSequenceIndex()
Returns the index indicating how to label a row.

Returns:
See above.

getDefaultSample

public int getDefaultSample()
Returns the currently selected field or 0.

Returns:
See above.

setDefaultSample

public void setDefaultSample(int value)
Sets the default sample.

Parameters:
value - The value to set.

getStatus

public String getStatus()
Returns the status of the plate.

Returns:
See above.

getExternalIdentifier

public String getExternalIdentifier()
Returns the external identifier of the plate.

Returns:
See above.

getPlateType

public String getPlateType()
Returns the type of plate e.g. A 384-Well Plate, 96-Well Plate.

Returns:
See above.

getWellOriginX

public double getWellOriginX()
Returns the x-coordinate in 2D-space of the well.

Returns:
See above

getWellOriginY

public double getWellOriginY()
Returns the y-coordinate in 2D-space of the well.

Returns:
See above

getPlateAcquisitions

public Set<PlateAcquisitionData> getPlateAcquisitions()
Returns the plate acquisitions related to this plate.

Returns:
See above.

setPlateAcquisition

public void setPlateAcquisition(Set<PlateAcquisitionData> value)
Sets the plate acquisition linked to the plate.

Parameters:
value - The set of plate acquisitions.

setExternalIdentifier

public void setExternalIdentifier(String value)
Sets the external identifier.

Parameters:
value - The value to set.

setStatus

public void setStatus(String value)
Sets the status.

Parameters:
value - The value to set.


OmeroJava Api

Version: 4.3.3-00d1137e-b2894

Copyright © 2009 The University of Dundee. All Rights Reserved.