Interface MultiWellPlate
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 ClassesModifier and TypeInterfaceDescriptionstatic interfaceBuilder for MultiWellPlate, seeMultiWellPlatefor function descriptions.static interfacestatic enum -
Method Summary
Modifier and TypeMethodDescriptionReturns the ColumnNamingConvention property of Plate, either LETTER or NUMBER.Get the number of Columns of the Plate.Returns a description of the Plate.Returns the external identifier (e.g.Returns the system-level unique identifier for this plate instance.Returns a human-readable name for this plate run.Returns the RowNamingConvention property of Plate, either LETTER or NUMBER.Returns the number of Rows of the Plate.Returns the status of the plate, i.e.This defines the X position to use for the origin of the fields (individual images) taken in a well.This defines the Y position to use for the origin of the fields (individual images) taken in a well.static StringindexToLabel(int index, MultiWellPlate.WellNamingConvention convention) Converts a 0-based index to its label under the given convention.static booleanisValidFor(char c, MultiWellPlate.WellNamingConvention convention) Returns true if c is a valid character for the given naming convention.static intlabelToIndex(String part, MultiWellPlate.WellNamingConvention convention) Converts a label part to its 0-based index under the given convention.static int[]parseWellLabel(String label, MultiWellPlate.WellNamingConvention rowConvention, MultiWellPlate.WellNamingConvention colConvention) Parses a well label such as "B6" into a 0-based (row, column) pair.static StringwellLabel(int row, int col, MultiWellPlate.WellNamingConvention rowConvention, MultiWellPlate.WellNamingConvention colConvention) Formats a 0-based (row, column) pair as a well label, e.g.
-
Method Details
-
wellLabel
static 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 indexcol- 0-based column indexrowConvention- naming convention for the row partcolConvention- naming convention for the column part- Returns:
- the well label
- Throws:
IllegalArgumentException- if row or col is negative
-
parseWellLabel
static int[] parseWellLabel(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, MultiWellPlate.WellNamingConvention, MultiWellPlate.WellNamingConvention).- Parameters:
label- the well label, e.g. "B6"rowConvention- naming convention for the row partcolConvention- naming convention for the column part- Returns:
- a two-element array, {row, col}, both 0-based
- Throws:
IllegalArgumentException- if the label does not match the conventions
-
isValidFor
Returns true if c is a valid character for the given naming convention. -
indexToLabel
Converts a 0-based index to its label under the given convention. -
labelToIndex
Converts a label part to its 0-based index under the given convention. -
getPlateColumns
Integer getPlateColumns()Get the number of Columns of the Plate.- Returns:
- the number of Columns of the Plate
-
getPlateDescription
String getPlateDescription()Returns a description of the Plate.- Returns:
- a description of the Plate
-
getPlateExternalIdentifier
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
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 usegetPlateExternalIdentifier().- Returns:
- the auto-generated unique identifier for this plate
-
getPlateName
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 fromgetPlateExternalIdentifier(), 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
Integer getPlateRows()Returns the number of Rows of the Plate.- Returns:
- the number of Rows of the Plate
-
getPlateStatus
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
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
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()
-