acquifer.core

Enum Plate

Object

Enum<Plate>

acquifer.core.Plate

All Implemented Interfaces:

Serializable, Comparable<Plate>

public enum Plate
extends Enum<Plate>

Defines classical fixed plates formats.
Plates are immutables, however one can modify a copy of the well-arrays returned by the getter methods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Wells12
Wells24
Wells384
Wells48
Wells6
Wells96

Method Summary

Modifier and Type	Method and Description
Well[][]	get2DArrayOfWells() Returns a copy of the 2D-array representing the wells contained in this plate.
int[]	getColumns() Return the range of column as an array of int.
String[]	getColumnsAsStrings() Return the range of columns as a String array starting with column 1.
int[]	getIndexesForColumn(int column) Return a list of positional indexes for the wells belonging to a given column, when wells are stored in a 1D array.
int[]	getIndexesForRow(char row) Return a list of positional indexes for the wells belonging to the specified row, when wells are stored in a 1D array..
String[]	getListOfWellIds() Return a list of Strings with the well labels.
Well[]	getListOfWells() Returns the list of wells as a 1D array.
List<String>	getListOfWellsAsStrings() Deprecated. use getListOfWellIds
int	getNumberOfColumns()
int	getNumberOfRows()
int	getNumberOfWells() Return the number of wells in this plate.
char	getRowChar(int row) Return the character for the given row-index (1-based).
char[]	getRows() Return a char array with the row letters.
String	getRowsAsString() Return the row letters as a single string.
String[]	getRowsAsStrings() Return a String array with the row letters.
Well	getWell(int row, int column) Return the wellId for the well at position [row][column] with 0-based indexes.
String	getWellId(int row, int column) Return the wellId for the well at position [row][column] with 0-based indexes.
static Plate	valueOf(String name) Returns the enum constant of this type with the specified name.
static Plate[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Wells6

public static final Plate Wells6

Wells12

public static final Plate Wells12

Wells24

public static final Plate Wells24

Wells48

public static final Plate Wells48

Wells96

public static final Plate Wells96

Wells384

public static final Plate Wells384

Method Detail

values

public static Plate[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Plate c : Plate.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Plate valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRows

public char[] getRows()

Return a char array with the row letters.

getRowsAsString

public String getRowsAsString()

Return the row letters as a single string.

getRowsAsStrings

public String[] getRowsAsStrings()

Return a String array with the row letters.

getColumns

public int[] getColumns()

Return the range of column as an array of int.

getNumberOfWells

public int getNumberOfWells()

Return the number of wells in this plate.

getNumberOfColumns

public int getNumberOfColumns()

getNumberOfRows

public int getNumberOfRows()

get2DArrayOfWells

public Well[][] get2DArrayOfWells()

Returns a copy of the 2D-array representing the wells contained in this plate.
The index for the 2D array is as following Plate{row]{columnm} with 0-based indexes.

getListOfWells

public Well[] getListOfWells()

Returns the list of wells as a 1D array.

getColumnsAsStrings

public String[] getColumnsAsStrings()

Return the range of columns as a String array starting with column 1. ex: ["1", "2"...]

getRowChar

public char getRowChar(int row)

Return the character for the given row-index (1-based).

Parameters:

row - between 1 and the number of rows in the plate

Throws:

IndexOutOfBoundsException - if row<1 or row>getNumberOfRows().

getListOfWellsAsStrings

@Deprecated
public List<String> getListOfWellsAsStrings()

Deprecated. use getListOfWellIds

Return a list of Strings with the well labels.
This can be used for instance as a filter with Utils.getListImages(directory, listWells...)

getWell

public Well getWell(int row,
                    int column)

Return the wellId for the well at position [row][column] with 0-based indexes.

getWellId

public String getWellId(int row,
                        int column)

Return the wellId for the well at position [row][column] with 0-based indexes.

getListOfWellIds

public String[] getListOfWellIds()

Return a list of Strings with the well labels.
This can be used for instance as a filter with Utils.getListImages(directory, listWells...)

getIndexesForRow

public int[] getIndexesForRow(char row)
                       throws IllegalArgumentException

Return a list of positional indexes for the wells belonging to the specified row, when wells are stored in a 1D array..
These indexes can be used in the BatchDialog to recover the checkboxes for a given row.

Parameters:

row - The character corresponding to the row of interest ex:'A'

Throws:

IllegalArgumentException

getIndexesForColumn

public int[] getIndexesForColumn(int column)
                          throws IllegalArgumentException

Return a list of positional indexes for the wells belonging to a given column, when wells are stored in a 1D array.

Parameters:

column - index for the column of interest, between 1 and nColumns (columns are 1-based).

Throws:

IllegalArgumentException