Plate (MicroFlex - Integer 1.0.1 API)

java.lang.Object
- com.github.jessemull.microflexinteger.plate.Plate

All Implemented Interfaces:: Comparable<Plate>, Iterable<Well>

public class Plate
extends Object
implements Iterable<Well>, Comparable<Plate>

This class represents a microplate used by chemists, biologists, physicists and many other natural science researchers. A microplate consists of a rectangular grid of wells. Rows are assigned a letter starting with A and working towards Z. Rows outside this range are identified by adding an additional letter to the row index (A -> ... -> Z -> AA -> AB). Columns are assigned integer values starting at zero working towards infinity. The row and column indices uniquely identify a single well (A1, A2 etc). Example of a typical microplate layout:

	1	2	3	4	5	6	7	8	9	10	11	12
A
B
C
D
E
F
G
H

The plate constructor accepts a flag for plates with standard dimensions:

Plate Type	Flag
6-Well	PLATE_6
12-Well	PLATE_12
24-Well	PLATE_24
48-Well	PLATE_48
96-Well	PLATE_96
384-Well	PLATE_384
1536-Well	PLATE_1536

Row and column numbers for plates with custom dimensions can be passed to the plate constructor. The plate data is implemented as a set of wells and a set of subgroups. Wells house the well ID and a list of values. Well subsets are used to aggregate data for different experimental conditions or replicates. Like all the members of the MicroFlex library the plate object is meant to be flexible, as such the constructors and methods accept all collection types, all numeric Java primitives and two immutable number objects:

Primitives
Byte
Short
Int
Long
Float
Double

Immutables
BigInteger
BigDecimal

Descriptive statistics and mathematical operations between plate stacks, plates, well sets and wells are performed using static methods housed within the statistics and math packages respectively. Custom mathematical or statistical calculations can be added by extending the MathOperation and DescriptiveStatistics abstract classes and over riding the calculate methods. The plate object implements comparable and iterable interfaces. The iterator iterates over the plate wells. Wells are compared using the well number, row number, column number, label then data type in that order.

Author:: Jesse L. Mull

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COLUMNS_12WELL`
`static int`	`COLUMNS_1536WELL`
`static int`	`COLUMNS_24WELL`
`static int`	`COLUMNS_384WELL`
`static int`	`COLUMNS_48WELL`
`static int`	`COLUMNS_6WELL`
`static int`	`COLUMNS_96WELL`
`static int`	`PLATE_12WELL`
`static int`	`PLATE_1536WELL`
`static int`	`PLATE_24WELL`
`static int`	`PLATE_384WELL`
`static int`	`PLATE_48WELL`
`static int`	`PLATE_6WELL`
`static int`	`PLATE_96WELL`
`static int`	`PLATE_BIGDECIMAL`
`static int`	`PLATE_BIGINTEGER`
`static int`	`PLATE_DOUBLE`
`static int`	`PLATE_INTEGER`
`static int`	`ROWS_12WELL`
`static int`	`ROWS_1536WELL`
`static int`	`ROWS_24WELL`
`static int`	`ROWS_384WELL`
`static int`	`ROWS_48WELL`
`static int`	`ROWS_6WELL`
`static int`	`ROWS_96WELL`

Constructor Summary

Constructors
Constructor and Description
`Plate(int type)` Creates a Integer plate.
`Plate(int rows, int columns)` Creates a Integer plate.
`Plate(int rows, int columns, String label)` Creates a Integer plate.
`Plate(int rows, int columns, String label, WellSet data)` Creates a Integer plate.
`Plate(int rows, int columns, WellSet set)` Creates a Integer plate.
`Plate(int type, String label)` Creates a Integer plate.
`Plate(int type, String label, WellSet data)` Creates a Integer plate.
`Plate(int type, WellSet set)` Creates a Integer plate.
`Plate(Plate plate)` Clones a Integer plate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroups(Collection<WellList> collection)` Adds a collection of well groups for analysis.
`void`	`addGroups(WellList list)` Adds a well group for analysis.
`void`	`addGroups(WellList[] array)` Adds an array of well groups for analysis.
`boolean`	`addWells(Collection<Well> collection)` Adds a collection of wells to the data set omitting wells that are already members of the set.
`boolean`	`addWells(Well well)` Adds a well to the data set.
`boolean`	`addWells(Well[] array)` Adds an array of wells to the data set omitting wells that are already members of the set.
`boolean`	`addWells(WellSet set)` Adds an array of wells to the data set omitting wells that are already members of the set.
`Set<WellSet>`	`allGroups()` Returns a well set for all analysis groups.
`Well`	`ceiling(Well well)` Returns the least well in this set greater than or equal to the given well, or null if there is no such well.
`void`	`clearGroups()` Clears all groups.
`boolean`	`clearWells()` Removes all plate wells.
`int`	`columns()` Returns the number of columns.
`int`	`compare(Plate plate1, Plate plate2)` Plates are ordered using the size, data type, label and number of sets.
`int`	`compareTo(Plate plate)` Compares the object to another plate.
`boolean`	`contains(Collection<Well> collection)` Returns true if all the input wells are found within the well set.
`boolean`	`contains(String well)` Returns true if the well is part of the well set.
`boolean`	`contains(String wellList, String delimiter)` Returns true if all the wells in the delimiter separated list exist in the plate.
`boolean`	`contains(Well well)` Returns true if the well is part of the well set.
`boolean`	`contains(Well[] array)` Returns true if all the input wells are found within the plate.
`boolean`	`contains(WellIndex index)` Returns true if a well with the index exists.
`boolean`	`contains(WellList list)` Returns true if the wells in the list exist.
`boolean`	`contains(WellSet set)` Returns true if all the input wells are found within the well set.
`boolean`	`containsGroup(Collection<WellList> collection)` Returns true if the groups in the collection exist.
`boolean`	`containsGroup(List<String> labels)` Returns true if groups with all the labels exist.
`boolean`	`containsGroup(String label)` Returns true if the group exists.
`boolean`	`containsGroup(WellList list)` Returns true if the group exists.
`boolean`	`containsGroup(WellList[] array)` Returns true if the groups in the array exist.
`WellSet`	`dataSet()` Returns the data set.
`int`	`dataType()` Returns the data type as an integer value.
`String`	`dataTypeString()` Returns the data type as a string.
`Iterator<Well>`	`descendingIterator()` Returns an iterator over the wells in this set in descending order.
`Set<Well>`	`descendingSet()` Returns a reverse order view of the wells contained in this set.
`String`	`descriptor()` Returns the descriptor.
`boolean`	`equals(Object object)` Plates are equivalent if they share the same dimensions, label, plate type, data type, descriptor, size and well sets.
`Well`	`first()` Returns the first well in the set.
`Well`	`floor(Well well)` Returns the greatest well in this set less than or equal to the given well, or null if there is no such well.
`WellSet`	`getColumn(int column)` Returns all wells with the matching column index.
`Set<WellSet>`	`getGroups(Collection<WellList> collection)` Returns a well set containing the wells for each group.
`Set<WellSet>`	`getGroups(List<String> labels)` Returns all wells with a label contained in the input list.
`WellSet`	`getGroups(String label)` Returns a well set containing the wells for the group with the given label.
`WellSet`	`getGroups(WellList list)` Returns a well set containing the wells for the group.
`Set<WellSet>`	`getGroups(WellList[] array)` Returns a well set containing the wells for each group.
`WellSet`	`getRow(int row)` Returns all wells with the matching row index.
`WellSet`	`getWells(Collection<Well> collection)` Returns the well or null if no such well exists.
`Well`	`getWells(String well)` Returns the well with the input indices.
`WellSet`	`getWells(String wellList, String delimiter)` Returns a well set holding all plate wells that match the indices or null if there are no matches.
`Well`	`getWells(Well well)` Returns the well or null if no such well exists.
`WellSet`	`getWells(Well[] array)` Returns the well or null if no such well exists.
`Well`	`getWells(WellIndex index)` Returns the well with the input index.
`WellSet`	`getWells(WellList list)` Returns the wells in the input list.
`WellSet`	`getWells(WellSet set)` Returns the well or null if no such well exists.
`int`	`hashCode()` Hash code uses the plate dimensions, label, plate type, data type, descriptor, size and well sets.
`Set<Well>`	`headSet(Well well)` Returns a view of the portion of this set whose wells are strictly less than the input well.
`Set<Well>`	`headSet(Well well, boolean inclusive)` Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) to the input well.
`Well`	`higher(Well well)` Returns the least well in this set strictly greater than the given well, or null if there is no such well.
`boolean`	`isEmpty()` Returns true if the plate is empty.
`Iterator<Well>`	`iterator()` Returns an iterator that iterates over the well in the plate.
`String`	`label()` Returns the plate label or the hash code if the label is undefined.
`Well`	`last()` Returns the last well in the set.
`Well`	`lower(Well well)` Returns the greatest well in this set strictly less than the given well, or null if there is no such well.
`Well`	`pollFirst()` Retrieves and removes the first (lowest) well, or returns null if this set is empty.
`Well`	`pollLast()` Retrieves and removes the last (highest) well, or returns null if this set is empty.
`String`	`printAllData()` Returns a string holding the well ID and data for all the plate wells.
`<T extends Number> String`	`printData(Well well)` Returns a string holding the well data.
`void`	`removeGroups(Collection<WellList> collection)` Removes a collection of well groups.
`void`	`removeGroups(List<String> labels)` Removes all wells with labels contained in the input list.
`void`	`removeGroups(String label)` Removes an the group with the label.
`void`	`removeGroups(WellList list)` Removes a well group.
`void`	`removeGroups(WellList[] array)` Removes an array of well groups.
`boolean`	`removeWells(Collection<Well> collection)` Removes a collection of wells.
`boolean`	`removeWells(String well)` Removes the well from the data set.
`boolean`	`removeWells(String wellList, String delimiter)` Removes the wells in the delimiter separated list.
`boolean`	`removeWells(Well well)` Removes the well from the data set.
`boolean`	`removeWells(Well[] wells)` Removes an array of wells.
`boolean`	`removeWells(WellIndex index)` Removes the well from the data set.
`boolean`	`removeWells(WellList list)` Removes a well list.
`boolean`	`removeWells(WellSet set)` Removes a set of wells.
`boolean`	`replaceWells(Collection<Well> collection)` Replaces the plate wells with the wells from the collection.
`boolean`	`replaceWells(Well well)` Replaces the plate well with the input well.
`boolean`	`replaceWells(Well[] array)` Replaces the plate wells with the wells from the array.
`boolean`	`replaceWells(WellSet set)` Replaces the plate wells with the wells from the well set.
`boolean`	`retainWells(Collection<Well> collection)` Retains the wells in the collection if they exist.
`boolean`	`retainWells(String well)` Retains the well in the data set.
`boolean`	`retainWells(String wellList, String delimiter)` Retains the wells in the delimiter separated list.
`boolean`	`retainWells(Well well)` Retains the input well if it exists.
`boolean`	`retainWells(Well[] array)` Retains the wells in the array if they exist.
`boolean`	`retainWells(WellIndex index)` Retains the well with the index.
`boolean`	`retainWells(WellList list)` Retains the wells in the list.
`boolean`	`retainWells(WellSet set)` Retains the wells in the well set if they exist.
`int`	`rows()` Returns the number of rows.
`void`	`setLabel(String newLabel)` Sets the label.
`int`	`size()` Returns the number of wells.
`Set<Well>`	`subSet(Well well1, boolean inclusive1, Well well2, boolean inclusive2)` Returns a view of the portion of this set whose wells range from the first input well to the second input well.
`Set<Well>`	`subSet(Well well1, Well well2)` Returns a view of the portion of this set whose wells range from the first input well inclusive to the second input well inclusive.
`Set<Well>`	`tailSet(Well well)` Returns a view of the portion of this set whose wells are greater than or equal to the input well.
`Set<Well>`	`tailSet(Well well, boolean inclusive)` Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the input well.
`Well[]`	`toArray()` Returns the plate wells in an array.
`String`	`toString()` Returns the plate descriptor and label.
`int`	`type()` Returns the plate type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - PLATE_6WELL
```
public static final int PLATE_6WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_12WELL
```
public static final int PLATE_12WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_24WELL
```
public static final int PLATE_24WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_48WELL
```
public static final int PLATE_48WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_96WELL
```
public static final int PLATE_96WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_384WELL
```
public static final int PLATE_384WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_1536WELL
```
public static final int PLATE_1536WELL
```
    See Also:
    
    Constant Field Values
  - PLATE_DOUBLE
```
public static final int PLATE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - PLATE_INTEGER
```
public static final int PLATE_INTEGER
```
    See Also:
    
    Constant Field Values
  - PLATE_BIGDECIMAL
```
public static final int PLATE_BIGDECIMAL
```
    See Also:
    
    Constant Field Values
  - PLATE_BIGINTEGER
```
public static final int PLATE_BIGINTEGER
```
    See Also:
    
    Constant Field Values
  - ROWS_6WELL
```
public static final int ROWS_6WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_12WELL
```
public static final int ROWS_12WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_24WELL
```
public static final int ROWS_24WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_48WELL
```
public static final int ROWS_48WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_96WELL
```
public static final int ROWS_96WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_384WELL
```
public static final int ROWS_384WELL
```
    See Also:
    
    Constant Field Values
  - ROWS_1536WELL
```
public static final int ROWS_1536WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_6WELL
```
public static final int COLUMNS_6WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_12WELL
```
public static final int COLUMNS_12WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_24WELL
```
public static final int COLUMNS_24WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_48WELL
```
public static final int COLUMNS_48WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_96WELL
```
public static final int COLUMNS_96WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_384WELL
```
public static final int COLUMNS_384WELL
```
    See Also:
    
    Constant Field Values
  - COLUMNS_1536WELL
```
public static final int COLUMNS_1536WELL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Plate
```
public Plate(int type)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - the plate type
  - Plate
```
public Plate(int rows,
             int columns)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate rows
    
    int - plate columns
  - Plate
```
public Plate(int type,
             String label)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate type flag
    
    String - plate label
  - Plate
```
public Plate(int rows,
             int columns,
             String label)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate rows
    
    int - plate columns
    
    String - plate label
  - Plate
```
public Plate(int type,
             WellSet set)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate type flag
    
    WellSet - well set
  - Plate
```
public Plate(int rows,
             int columns,
             WellSet set)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - number of plate rows
    
    int - number of plate columns
    
    WellSet - plate well sets
  - Plate
```
public Plate(int type,
             String label,
             WellSet data)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate type flag
    
    String - plate label
    
    WellSet - plate well set
  - Plate
```
public Plate(int rows,
             int columns,
             String label,
             WellSet data)
```
    Creates a Integer plate.
    
    Parameters:
    
    int - plate rows
    
    int - plate columns
    
    String - plate label
    
    E - plate well set
  - Plate
```
public Plate(Plate plate)
```
    Clones a Integer plate.
    
    Parameters:
    
    Plate - plate to clone
- Method Detail
  - addGroups
```
public void addGroups(WellList list)
```
    Adds a well group for analysis.
    
    Parameters:
    
    WellList - the list of wells
  - addGroups
```
public void addGroups(Collection<WellList> collection)
```
    Adds a collection of well groups for analysis.
    
    Parameters:
    
    Collection - collection of groups
  - addGroups
```
public void addGroups(WellList[] array)
```
    Adds an array of well groups for analysis.
    
    Parameters:
    
    WellList[] - array of groups
  - removeGroups
```
public void removeGroups(WellList list)
```
    Removes a well group.
    
    Parameters:
    
    WellList - the group
  - removeGroups
```
public void removeGroups(Collection<WellList> collection)
```
    Removes a collection of well groups.
    
    Parameters:
    
    Collection - the collection of well groups
  - removeGroups
```
public void removeGroups(WellList[] array)
```
    Removes an array of well groups.
    
    Parameters:
    
    WellList[] - the array of well groups
  - removeGroups
```
public void removeGroups(String label)
```
    Removes an the group with the label.
    
    Parameters:
    
    String - the group label
  - removeGroups
```
public void removeGroups(List<String> labels)
```
    Removes all wells with labels contained in the input list.
    
    Parameters:
    
    List - the group labels
  - clearGroups
```
public void clearGroups()
```
    Clears all groups.
  - allGroups
```
public Set<WellSet> allGroups()
```
    Returns a well set for all analysis groups.
    
    Returns:
    
    well sets for each group
  - getGroups
```
public WellSet getGroups(String label)
```
    Returns a well set containing the wells for the group with the given label.
    
    Parameters:
    
    String - label
    
    Returns:
    
    well set containing the group wells
  - getGroups
```
public WellSet getGroups(WellList list)
```
    Returns a well set containing the wells for the group.
    
    Parameters:
    
    WellList - the group
    
    Returns:
    
    well set containing the group wells
  - getGroups
```
public Set<WellSet> getGroups(Collection<WellList> collection)
```
    Returns a well set containing the wells for each group.
    
    Parameters:
    
    Collection - the collection of groups
    
    Returns:
    
    wells for each group
  - getGroups
```
public Set<WellSet> getGroups(WellList[] array)
```
    Returns a well set containing the wells for each group.
    
    Parameters:
    
    WellList[] - the array of groups
    
    Returns:
    
    wells for each group
  - getGroups
```
public Set<WellSet> getGroups(List<String> labels)
```
    Returns all wells with a label contained in the input list.
    
    Parameters:
    
    List - the group labels
    
    Returns:
    
    set of group data
  - containsGroup
```
public boolean containsGroup(String label)
```
    Returns true if the group exists.
    
    Parameters:
    
    String - label
    
    Returns:
    
    true on successful lookup
  - containsGroup
```
public boolean containsGroup(List<String> labels)
```
    Returns true if groups with all the labels exist.
    
    Parameters:
    
    List - label
    
    Returns:
    
    true on successful lookup
  - containsGroup
```
public boolean containsGroup(WellList list)
```
    Returns true if the group exists.
    
    Parameters:
    
    WellList - the group
    
    Returns:
    
    true on successful lookup
  - containsGroup
```
public boolean containsGroup(Collection<WellList> collection)
```
    Returns true if the groups in the collection exist.
    
    Parameters:
    
    Collection - collection of groups
    
    Returns:
    
    true on successful lookup
  - containsGroup
```
public boolean containsGroup(WellList[] array)
```
    Returns true if the groups in the array exist.
    
    Parameters:
    
    WellList[] - array of groups
    
    Returns:
    
    true on successful lookup
  - higher
```
public Well higher(Well well)
```
    Returns the least well in this set strictly greater than the given well, or null if there is no such well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    greatest well less than or equal to the input well
  - lower
```
public Well lower(Well well)
```
    Returns the greatest well in this set strictly less than the given well, or null if there is no such well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    least well greater than or equal to the input well
  - pollFirst
```
public Well pollFirst()
```
    Retrieves and removes the first (lowest) well, or returns null if this set is empty.
    
    Returns:
    
    first/lowest well
  - pollLast
```
public Well pollLast()
```
    Retrieves and removes the last (highest) well, or returns null if this set is empty.
    
    Returns:
    
    last/highest well
  - iterator
```
public Iterator<Well> iterator()
```
    Returns an iterator that iterates over the well in the plate.
    
    Specified by:
    
    iterator in interface Iterable<Well>
    
    Returns:
    
    iterator for plate wells
  - descendingIterator
```
public Iterator<Well> descendingIterator()
```
    Returns an iterator over the wells in this set in descending order.
    
    Returns:
    
    iterator for traversing set in descending order
  - descendingSet
```
public Set<Well> descendingSet()
```
    Returns a reverse order view of the wells contained in this set.
    
    Returns:
    
    the set in descending order
  - first
```
public Well first()
```
    Returns the first well in the set.
    
    Returns:
    
    the first well in the set
  - last
```
public Well last()
```
    Returns the last well in the set.
    
    Returns:
    
    the first well in the set
  - ceiling
```
public Well ceiling(Well well)
```
    Returns the least well in this set greater than or equal to the given well, or null if there is no such well.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    least well greater than or equal to the input well
  - floor
```
public Well floor(Well well)
```
    Returns the greatest well in this set less than or equal to the given well, or null if there is no such well.
    
    Returns:
    
    greatest well less than or equal to the input well
  - headSet
```
public Set<Well> headSet(Well well)
```
    Returns a view of the portion of this set whose wells are strictly less than the input well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    well set with wells less than the input well
  - headSet
```
public Set<Well> headSet(Well well,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) to the input well.
    
    Parameters:
    
    Well - well input well
    
    boolean - a true value retains the input well in the sub set
    
    Returns:
    
    well set with wells less than the input well
  - tailSet
```
public Set<Well> tailSet(Well well)
```
    Returns a view of the portion of this set whose wells are greater than or equal to the input well.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - tailSet
```
public Set<Well> tailSet(Well well,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the input well.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - subSet
```
public Set<Well> subSet(Well well1,
                        boolean inclusive1,
                        Well well2,
                        boolean inclusive2)
```
    Returns a view of the portion of this set whose wells range from the first input well to the second input well.
    
    Parameters:
    
    Well - the first input well
    
    Well - the second input well
    
    boolean - includes the first input well in the returned set
    
    boolean - includes the second input well in the returned set
    
    Returns:
    
    last well in the set
  - subSet
```
public Set<Well> subSet(Well well1,
                        Well well2)
```
    Returns a view of the portion of this set whose wells range from the first input well inclusive to the second input well inclusive.
    
    Parameters:
    
    Well - the first input well
    
    Well - the second input well
    
    Returns:
    
    last well in the set
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the plate is empty.
    
    Returns:
    
    true if plate has no wells
  - label
```
public String label()
```
    Returns the plate label or the hash code if the label is undefined.
    
    Returns:
    
    label or hash code if the label is undefined
  - setLabel
```
public void setLabel(String newLabel)
```
    Sets the label.
    
    Parameters:
    
    String - the new label
  - columns
```
public int columns()
```
    Returns the number of columns.
    
    Returns:
    
    number of columns
  - rows
```
public int rows()
```
    Returns the number of rows.
    
    Returns:
    
    number of rows
  - size
```
public int size()
```
    Returns the number of wells.
    
    Returns:
    
    number of wells
  - type
```
public int type()
```
    Returns the plate type.
    
    Returns:
    
    the plate type
  - descriptor
```
public String descriptor()
```
    Returns the descriptor.
    
    Returns:
    
    descriptor
  - dataType
```
public int dataType()
```
    Returns the data type as an integer value.
    
    Returns:
    
    the data type
  - dataTypeString
```
public String dataTypeString()
```
    Returns the data type as a string.
    
    Returns:
    
    the data type
  - toString
```
public String toString()
```
    Returns the plate descriptor and label.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    plate descriptor and label
  - dataSet
```
public WellSet dataSet()
```
    Returns the data set.
    
    Returns:
    
    the data set
  - toArray
```
public Well[] toArray()
```
    Returns the plate wells in an array. Overflow results in an arithmetic exception.
    
    Returns:
    
    the data set as an array of wells
  - addWells
```
public boolean addWells(Well well)
```
    Adds a well to the data set.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true on successful addition of the well
  - addWells
```
public boolean addWells(WellSet set)
```
    Adds an array of wells to the data set omitting wells that are already members of the set.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful addition of all the wells in the set
  - addWells
```
public boolean addWells(Collection<Well> collection)
```
    Adds a collection of wells to the data set omitting wells that are already members of the set.
    
    Parameters:
    
    Collection - the well collection
    
    Returns:
    
    true on successful addition of all the wells in the collection
  - addWells
```
public boolean addWells(Well[] array)
```
    Adds an array of wells to the data set omitting wells that are already members of the set.
    
    Parameters:
    
    WellInteger[] - the well array
    
    Returns:
    
    true on successful addition of all the wells in the array
  - removeWells
```
public boolean removeWells(Well well)
```
    Removes the well from the data set.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true on successful well removal
  - removeWells
```
public boolean removeWells(WellSet set)
```
    Removes a set of wells.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful removal of all wells
  - removeWells
```
public boolean removeWells(Collection<Well> collection)
```
    Removes a collection of wells.
    
    Parameters:
    
    Collection - collection of wells to remove
    
    Returns:
    
    true on successful removal of all wells
  - removeWells
```
public boolean removeWells(Well[] wells)
```
    Removes an array of wells.
    
    Parameters:
    
    WellInteger[] - array of wells to remove
    
    Returns:
    
    true on successful removal of all wells
  - removeWells
```
public boolean removeWells(String wellList,
                           String delimiter)
```
    Removes the wells in the delimiter separated list.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    true on successful removal
  - removeWells
```
public boolean removeWells(String well)
```
    Removes the well from the data set.
    
    Parameters:
    
    String - the well
    
    Returns:
    
    true on successful well removal
  - removeWells
```
public boolean removeWells(WellIndex index)
```
    Removes the well from the data set.
    
    Parameters:
    
    String - the index
    
    Returns:
    
    true on successful well removal
  - removeWells
```
public boolean removeWells(WellList list)
```
    Removes a well list.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    true on successful removal of all wells
  - clearWells
```
public boolean clearWells()
```
    Removes all plate wells.
    
    Returns:
    
    true on successful removal of all wells
  - replaceWells
```
public boolean replaceWells(Well well)
```
    Replaces the plate well with the input well. Adds the well if the well does not exist.
    
    Parameters:
    
    Well - the well for replacement
    
    Returns:
    
    true on successful well replacement
  - replaceWells
```
public boolean replaceWells(WellSet set)
```
    Replaces the plate wells with the wells from the well set. Adds the well if the well does not exist.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful replacement of all wells
  - replaceWells
```
public boolean replaceWells(Collection<Well> collection)
```
    Replaces the plate wells with the wells from the collection. Adds the well if the well does not exist.
    
    Parameters:
    
    Collection - the data collection
    
    Returns:
    
    true on successful replacement of all wells
  - replaceWells
```
public boolean replaceWells(Well[] array)
```
    Replaces the plate wells with the wells from the array. Adds the well data if the well does not exist.
    
    Parameters:
    
    WellInteger[] - the array of wells
    
    Returns:
    
    true on successful replacement of all wells
  - retainWells
```
public boolean retainWells(Well well)
```
    Retains the input well if it exists.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true on successful well retention
  - retainWells
```
public boolean retainWells(WellSet set)
```
    Retains the wells in the well set if they exist.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful retention of all wells
  - retainWells
```
public boolean retainWells(Collection<Well> collection)
```
    Retains the wells in the collection if they exist.
    
    Parameters:
    
    Collection - the data collection
    
    Returns:
    
    true on successful retention of all wells
  - retainWells
```
public boolean retainWells(Well[] array)
```
    Retains the wells in the array if they exist.
    
    Parameters:
    
    WellInteger[] - the array of wells
    
    Returns:
    
    true on successful retention of all wells
  - retainWells
```
public boolean retainWells(String wellList,
                           String delimiter)
```
    Retains the wells in the delimiter separated list.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    true on successful removal
  - retainWells
```
public boolean retainWells(String well)
```
    Retains the well in the data set.
    
    Parameters:
    
    String - the well
    
    Returns:
    
    true on successful well removal
  - retainWells
```
public boolean retainWells(WellIndex index)
```
    Retains the well with the index.
    
    Parameters:
    
    WellIndex - the well index
    
    Returns:
    
    true on successful well retention
  - retainWells
```
public boolean retainWells(WellList list)
```
    Retains the wells in the list.
    
    Parameters:
    
    WellList - the well list
    
    boolean - true on successful well retention
  - getWells
```
public Well getWells(Well well)
```
    Returns the well or null if no such well exists.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    the plate well or null if the well does not exist
  - getWells
```
public WellSet getWells(WellSet set)
```
    Returns the well or null if no such well exists.
    
    Parameters:
    
    WellSet - the well
    
    Returns:
    
    the well set
  - getWells
```
public WellSet getWells(Collection<Well> collection)
```
    Returns the well or null if no such well exists.
    
    Parameters:
    
    WellInteger[] - the well
    
    Returns:
    
    the well set
  - getWells
```
public WellSet getWells(Well[] array)
```
    Returns the well or null if no such well exists.
    
    Parameters:
    
    WellInteger[] - the well
    
    Returns:
    
    the well set
  - getWells
```
public WellSet getWells(String wellList,
                        String delimiter)
```
    Returns a well set holding all plate wells that match the indices or null if there are no matches.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    all wells with matching well indices or null
  - getWells
```
public Well getWells(String well)
```
    Returns the well with the input indices.
    
    Parameters:
    
    String - the well ID
    
    Returns:
    
    well with matching well ID
  - getWells
```
public Well getWells(WellIndex index)
```
    Returns the well with the input index.
    
    Parameters:
    
    WellIndex - the well index
    
    Returns:
    
    well with matching index
  - getWells
```
public WellSet getWells(WellList list)
```
    Returns the wells in the input list.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    set of matching wells
  - getRow
```
public WellSet getRow(int row)
```
    Returns all wells with the matching row index.
    
    Parameters:
    
    int - the row index
    
    Returns:
    
    wells with matching row index
  - getColumn
```
public WellSet getColumn(int column)
```
    Returns all wells with the matching column index.
    
    Parameters:
    
    int - the row index
    
    Returns:
    
    wells with the matching column index
  - contains
```
public boolean contains(Well well)
```
    Returns true if the well is part of the well set.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true if the well exists in the set
  - contains
```
public boolean contains(WellSet set)
```
    Returns true if all the input wells are found within the well set.
    
    Parameters:
    
    WellSet - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(Collection<Well> collection)
```
    Returns true if all the input wells are found within the well set.
    
    Parameters:
    
    Collection - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(Well[] array)
```
    Returns true if all the input wells are found within the plate.
    
    Parameters:
    
    WellInteger[] - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(String wellList,
                        String delimiter)
```
    Returns true if all the wells in the delimiter separated list exist in the plate.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    true if all the wells exist
  - contains
```
public boolean contains(String well)
```
    Returns true if the well is part of the well set.
    
    Parameters:
    
    String - the well
    
    Returns:
    
    true if the well exists in the set
  - contains
```
public boolean contains(WellIndex index)
```
    Returns true if a well with the index exists.
  - contains
```
public boolean contains(WellList list)
```
    Returns true if the wells in the list exist.
  - printAllData
```
public String printAllData()
```
    Returns a string holding the well ID and data for all the plate wells.
    
    Returns:
    
    well IDs and data
  - printData
```
public <T extends Number> String printData(Well well)
```
    Returns a string holding the well data.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    the well data
  - equals
```
public boolean equals(Object object)
```
    Plates are equivalent if they share the same dimensions, label, plate type, data type, descriptor, size and well sets.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    Object - the object
    
    Returns:
    
    true if equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Hash code uses the plate dimensions, label, plate type, data type, descriptor, size and well sets.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code
  - compareTo
```
public int compareTo(Plate plate)
```
    Compares the object to another plate.
    
    Specified by:
    
    compareTo in interface Comparable<Plate>
    
    Parameters:
    
    Plate - plate the plate for comparison
    
    Returns:
    
    this == plate --> 0 this > plate --> 1 this < plate --> -1
  - compare
```
public int compare(Plate plate1,
                   Plate plate2)
            throws ClassCastException
```
    Plates are ordered using the size, data type, label and number of sets.
    
    Parameters:
    
    Plate - the plate for comparison
    
    Returns:
    
    plate1 == plate2 --> 0 plate1 > plate2 --> 1 plate1 < plate2 --> -1
    
    Throws:
    
    ClassCastException

Class Plate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

PLATE_6WELL

PLATE_12WELL

PLATE_24WELL

PLATE_48WELL

PLATE_96WELL

PLATE_384WELL

PLATE_1536WELL

PLATE_DOUBLE

PLATE_INTEGER

PLATE_BIGDECIMAL

PLATE_BIGINTEGER

ROWS_6WELL

ROWS_12WELL

ROWS_24WELL

ROWS_48WELL

ROWS_96WELL

ROWS_384WELL

ROWS_1536WELL

COLUMNS_6WELL

COLUMNS_12WELL

COLUMNS_24WELL

COLUMNS_48WELL

COLUMNS_96WELL

COLUMNS_384WELL

COLUMNS_1536WELL

Constructor Detail

Plate

Plate

Plate

Plate

Plate

Plate

Plate

Plate

Plate

Method Detail

addGroups

addGroups

addGroups

removeGroups

removeGroups

removeGroups

removeGroups

removeGroups

clearGroups

allGroups

getGroups

getGroups

getGroups

getGroups

getGroups

containsGroup

containsGroup

containsGroup

containsGroup

containsGroup

higher

lower

pollFirst

pollLast

iterator

descendingIterator

descendingSet

first

last

ceiling

floor

headSet

headSet

tailSet

tailSet

subSet

subSet