PlateData (OMERO API)

java.lang.Object
- omero.gateway.model.DataObject
- - omero.gateway.model.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

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANNOTATIONS` Identifies the `PlateI.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 java.lang.String`	`DESCRIPTION` Identifies the `PlateI.DESCRIPTION` field.
`static java.lang.String`	`NAME` Identifies the `PlateI.NAME` field.
`static java.lang.String`	`SCREEN_LINKS` Identifies the `PlateI.SCREENLINKS` field.
`static java.lang.String`	`WELLS` Identifies the `PlateI.WELLS` field.

Constructor Summary

Constructors
Constructor and Description

PlateData()
Creates a new instance.

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

Constructors
Constructor and Description
`PlateData()` Creates a new instance.
`PlateData(omero.model.Plate plate)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.Long,java.lang.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`.
`java.lang.String`	`getDescription()` Returns the description of the plate.
`java.lang.String`	`getExternalIdentifier()` Returns the external identifier of the plate.
`java.lang.String`	`getName()` Returns the name of the plate.
`java.util.Set<PlateAcquisitionData>`	`getPlateAcquisitions()` Returns the plate acquisitions related to this plate.
`java.lang.String`	`getPlateType()` Returns the type of plate e.g.
`int`	`getRowSequenceIndex()` Returns the index indicating how to label a row.
`java.util.Set<ScreenData>`	`getScreens()` Returns a set of screens containing the plate.
`java.lang.String`	`getStatus()` Returns the status of the plate.
`omero.model.Length`	`getWellOriginX(omero.model.enums.UnitsLength unit)` Returns the x-coordinate in 2D-space of the well.
`omero.model.Length`	`getWellOriginY(omero.model.enums.UnitsLength unit)` Returns the y-coordinate in 2D-space of the well.
`void`	`setDefaultSample(int value)` Sets the default sample.
`void`	`setDescription(java.lang.String description)` Sets the description of the plate.
`void`	`setExternalIdentifier(java.lang.String value)` Sets the external identifier.
`void`	`setName(java.lang.String name)` Sets the name of the plate.
`void`	`setPlateAcquisition(java.util.Set<PlateAcquisitionData> value)` Sets the plate acquisition linked to the plate.
`void`	`setScreens(java.util.Set<ScreenData> value)` Sets the screens containing the plate.
`void`	`setStatus(java.lang.String value)` Sets the status.

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, canChgrp, canChown, 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

- 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 java.lang.String NAME
```
    Identifies the PlateI.NAME field.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    Identifies the PlateI.DESCRIPTION field.
    
    See Also:
    
    Constant Field Values
  - WELLS
```
public static final java.lang.String WELLS
```
    Identifies the PlateI.WELLS field.
    
    See Also:
    
    Constant Field Values
  - SCREEN_LINKS
```
public static final java.lang.String SCREEN_LINKS
```
    Identifies the PlateI.SCREENLINKS field.
    
    See Also:
    
    Constant Field Values
  - ANNOTATIONS
```
public static final java.lang.String ANNOTATIONS
```
    Identifies the PlateI.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:
    
    java.lang.IllegalArgumentException - If the object is null.
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the plate.
    
    Parameters:
    
    name - The name of the plate. Mustn't be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the name is null.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the plate.
    
    Returns:
    
    See above.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of the plate.
    
    Parameters:
    
    description - The description of the plate.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of the plate.
    
    Returns:
    
    See above.
  - getAnnotationsCounts
```
public java.util.Map<java.lang.Long,java.lang.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 java.util.Set<ScreenData> getScreens()
```
    Returns a set of screens containing the plate.
    
    Returns:
    
    See above.
  - setScreens
```
public void setScreens(java.util.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 java.lang.String getStatus()
```
    Returns the status of the plate.
    
    Returns:
    
    See above.
  - getExternalIdentifier
```
public java.lang.String getExternalIdentifier()
```
    Returns the external identifier of the plate.
    
    Returns:
    
    See above.
  - getPlateType
```
public java.lang.String getPlateType()
```
    Returns the type of plate e.g. A 384-Well Plate, 96-Well Plate.
    
    Returns:
    
    See above.
  - getWellOriginX
```
public omero.model.Length getWellOriginX(omero.model.enums.UnitsLength unit)
                                  throws BigResult
```
    Returns the x-coordinate in 2D-space of the well.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above
    
    Throws:
    
    BigResult - If an arithmetic under-/overflow occurred
  - getWellOriginY
```
public omero.model.Length getWellOriginY(omero.model.enums.UnitsLength unit)
                                  throws BigResult
```
    Returns the y-coordinate in 2D-space of the well.
    
    Parameters:
    
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    
    See above
    
    Throws:
    
    BigResult - If an arithmetic under-/overflow occurred
  - getPlateAcquisitions
```
public java.util.Set<PlateAcquisitionData> getPlateAcquisitions()
```
    Returns the plate acquisitions related to this plate.
    
    Returns:
    
    See above.
  - setPlateAcquisition
```
public void setPlateAcquisition(java.util.Set<PlateAcquisitionData> value)
```
    Sets the plate acquisition linked to the plate.
    
    Parameters:
    
    value - The set of plate acquisitions.
  - setExternalIdentifier
```
public void setExternalIdentifier(java.lang.String value)
```
    Sets the external identifier.
    
    Parameters:
    
    value - The value to set.
  - setStatus
```
public void setStatus(java.lang.String value)
```
    Sets the status.
    
    Parameters:
    
    value - The value to set.

Class PlateData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

ASCENDING_NUMBER

ASCENDING_LETTER

DESCENDING_NUMBER

DESCENDING_LETTER

NAME

DESCRIPTION

WELLS

SCREEN_LINKS

ANNOTATIONS

Constructor Detail

PlateData

PlateData

Method Detail

setName

getName

setDescription

getDescription

getAnnotationsCounts

getScreens

setScreens

getColumnSequenceIndex

getRowSequenceIndex

getDefaultSample

setDefaultSample

getStatus

getExternalIdentifier

getPlateType

getWellOriginX

getWellOriginY

getPlateAcquisitions

setPlateAcquisition

setExternalIdentifier

setStatus