MultiWellPlate

```
public interface MultiWellPlate
```
Metadata describing a multi-well plate, modelled after the OME Plate element.
There are three distinct identity fields:
- getPlateID() — a machine-generated unique key (e.g. UUID) used internally by OME-XML to link Wells and WellSamples to this Plate. It is auto-generated and should not be entered or interpreted by users.
- getPlateName() — a human-readable label chosen by the user for this specific plate run (e.g. "Batch-42-A").
- getPlateExternalIdentifier() — a barcode, LIMS ID, or other reference that ties this plate to an external tracking system. This is the primary traceability field and is entered by the user.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`MultiWellPlate.Builder` Builder for MultiWellPlate, see `MultiWellPlate` for function descriptions.
`static interface`	`MultiWellPlate.FromPropertyMapBuilder`
`static class`	`MultiWellPlate.WellNamingConvention`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`MultiWellPlate.WellNamingConvention`	`getPlateColumnNamingConvention()` Returns the ColumnNamingConvention property of Plate, either LETTER or NUMBER.
`java.lang.Integer`	`getPlateColumns()` Get the number of Columns of the Plate.
`java.lang.String`	`getPlateDescription()` Returns a description of the Plate.
`java.lang.String`	`getPlateExternalIdentifier()` Returns the external identifier (e.g.
`java.lang.String`	`getPlateID()` Returns the system-level unique identifier for this plate instance.
`java.lang.String`	`getPlateName()` Returns a human-readable name for this plate run.
`MultiWellPlate.WellNamingConvention`	`getPlateRowNamingConvention()` Returns the RowNamingConvention property of Plate, either LETTER or NUMBER.
`java.lang.Integer`	`getPlateRows()` Returns the number of Rows of the Plate.
`java.lang.String`	`getPlateStatus()` Returns the status of the plate, i.e.
`java.lang.Double`	`getPlateWellOriginXUm()` This defines the X position to use for the origin of the fields (individual images) taken in a well.
`java.lang.Double`	`getPlateWellOriginYUm()` This defines the Y position to use for the origin of the fields (individual images) taken in a well.
`static java.lang.String`	`indexToLabel(int index, MultiWellPlate.WellNamingConvention convention)` Converts a 0-based index to its label under the given convention.
`static boolean`	`isValidFor(char c, MultiWellPlate.WellNamingConvention convention)` Returns true if c is a valid character for the given naming convention.
`static int`	`labelToIndex(java.lang.String part, MultiWellPlate.WellNamingConvention convention)` Converts a label part to its 0-based index under the given convention.
`static int[]`	`parseWellLabel(java.lang.String label, MultiWellPlate.WellNamingConvention rowConvention, MultiWellPlate.WellNamingConvention colConvention)` Parses a well label such as "B6" into a 0-based (row, column) pair.
`PropertyMap`	`toPropertyMap()`
`static java.lang.String`	`wellLabel(int row, int col, MultiWellPlate.WellNamingConvention rowConvention, MultiWellPlate.WellNamingConvention colConvention)` Formats a 0-based (row, column) pair as a well label, e.g.

- Method Detail
  - wellLabel
```
static java.lang.String wellLabel(int row,
                                  int col,
                                  MultiWellPlate.WellNamingConvention rowConvention,
                                  MultiWellPlate.WellNamingConvention colConvention)
```
    Formats a 0-based (row, column) pair as a well label, e.g. (1, 5) -> "B6" when rows are named with letters and columns with numbers.
    LETTER naming uses a bijective base-26 sequence: A-Z, then AA, AB, ... NUMBER naming is simply the 1-based index.
    
    Parameters:
    
    row - 0-based row index
    
    col - 0-based column index
    
    rowConvention - naming convention for the row part
    
    colConvention - naming convention for the column part
    
    Returns:
    
    the well label
    
    Throws:
    
    java.lang.IllegalArgumentException - if row or col is negative
  - parseWellLabel
```
static int[] parseWellLabel(java.lang.String label,
                            MultiWellPlate.WellNamingConvention rowConvention,
                            MultiWellPlate.WellNamingConvention colConvention)
```
    Parses a well label such as "B6" into a 0-based (row, column) pair.
    The label is split according to the given naming conventions: a LETTER part matches a run of letters, a NUMBER part a run of digits. This is the inverse of wellLabel(int, int, org.micromanager.data.MultiWellPlate.WellNamingConvention, org.micromanager.data.MultiWellPlate.WellNamingConvention).
    
    Parameters:
    
    label - the well label, e.g. "B6"
    
    rowConvention - naming convention for the row part
    
    colConvention - naming convention for the column part
    
    Returns:
    
    a two-element array, {row, col}, both 0-based
    
    Throws:
    
    java.lang.IllegalArgumentException - if the label does not match the conventions
  - isValidFor
```
static boolean isValidFor(char c,
                          MultiWellPlate.WellNamingConvention convention)
```
    Returns true if c is a valid character for the given naming convention.
  - indexToLabel
```
static java.lang.String indexToLabel(int index,
                                     MultiWellPlate.WellNamingConvention convention)
```
    Converts a 0-based index to its label under the given convention.
  - labelToIndex
```
static int labelToIndex(java.lang.String part,
                        MultiWellPlate.WellNamingConvention convention)
```
    Converts a label part to its 0-based index under the given convention.
  - getPlateColumns
```
java.lang.Integer getPlateColumns()
```
    Get the number of Columns of the Plate.
    
    Returns:
    
    the number of Columns of the Plate
  - getPlateDescription
```
java.lang.String getPlateDescription()
```
    Returns a description of the Plate.
    
    Returns:
    
    a description of the Plate
  - getPlateExternalIdentifier
```
java.lang.String getPlateExternalIdentifier()
```
    Returns the external identifier (e.g. barcode or LIMS ID) for this plate.
    This field is intended for traceability: it ties the plate to an entry in an external system such as a Laboratory Information Management System (LIMS) or a physical barcode label on the plate. Unlike getPlateID(), which is auto-generated, this value is entered by the user and may be left blank if no external tracking is used.
    
    Returns:
    
    the external identifier string, or null/empty if not set
  - getPlateID
```
java.lang.String getPlateID()
```
    Returns the system-level unique identifier for this plate instance.
    This ID is intended for machine use: it must be unique within the OME-XML document so that Wells and WellSamples can reference this Plate unambiguously. It is auto-generated (e.g. a UUID) when plate metadata is created and should not be entered or interpreted by users. For a human-readable label use getPlateName(); for a barcode or LIMS reference use getPlateExternalIdentifier().
    
    Returns:
    
    the auto-generated unique identifier for this plate
  - getPlateName
```
java.lang.String getPlateName()
```
    Returns a human-readable name for this plate run.
    The Name identifies the plate to the user (e.g. "Batch-42-A"). It is distinct from getPlateID(), which is a machine-generated key, and from getPlateExternalIdentifier(), which is a barcode or LIMS reference. If a plate name is not available, OME/OMERO will fall back to "Start time - End time", or finally to the plate ID.
    
    Returns:
    
    a human-readable name of the plate, or null/empty if not set
  - getPlateRowNamingConvention
```
MultiWellPlate.WellNamingConvention getPlateRowNamingConvention()
```
    Returns the RowNamingConvention property of Plate, either LETTER or NUMBER.
    
    Returns:
    
    the RowNamingConvention property of Plate
  - getPlateColumnNamingConvention
```
MultiWellPlate.WellNamingConvention getPlateColumnNamingConvention()
```
    Returns the ColumnNamingConvention property of Plate, either LETTER or NUMBER.
    
    Returns:
    
    the ColumnNamingConvention property of Plate
  - getPlateRows
```
java.lang.Integer getPlateRows()
```
    Returns the number of Rows of the Plate.
    
    Returns:
    
    the number of Rows of the Plate
  - getPlateStatus
```
java.lang.String getPlateStatus()
```
    Returns the status of the plate, i.e. a textual annotation of the current state of the plate with respect to the experiment work-flow; e.g. 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo.
    
    Returns:
    
    the status of the plate
  - getPlateWellOriginXUm
```
java.lang.Double getPlateWellOriginXUm()
```
    This defines the X position to use for the origin of the fields (individual images) taken in a well. It is used with the X in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. We use microns as the unit. In the OMERO clients by convention we display the WellOrigin in the center of the view.
    
    Returns:
    
    the origin for the well sample positions in the well
  - getPlateWellOriginYUm
```
java.lang.Double getPlateWellOriginYUm()
```
    This defines the Y position to use for the origin of the fields (individual images) taken in a well. It is used with the Y in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. We use microns as the unit. In the OMERO clients by convention we display the WellOrigin in the center of the view.
    
    Returns:
    
    the origin for the well sample positions in the well
  - toPropertyMap
```
PropertyMap toPropertyMap()
```

Interface MultiWellPlate

Nested Class Summary

Method Summary

Method Detail

wellLabel

parseWellLabel

isValidFor

indexToLabel

labelToIndex

getPlateColumns

getPlateDescription

getPlateExternalIdentifier

getPlateID

getPlateName

getPlateRowNamingConvention

getPlateColumnNamingConvention

getPlateRows

getPlateStatus

getPlateWellOriginXUm

getPlateWellOriginYUm

toPropertyMap