WellPrecursor (MicroFlex - Integer 1.0.1 API)

java.lang.Object
- com.github.jessemull.microflexinteger.plate.WellPrecursor<T>

All Implemented Interfaces:: Comparable<WellPrecursor<T>>

Direct Known Subclasses:: Well

public abstract class WellPrecursor<T extends Number>
extends Object
implements Comparable<WellPrecursor<T>>

This class represents a well in a microplate. It contains the the logic to convert row letters to integers and vice-versa, enforces the correct format for well IDs and holds a list of data set values. The well object does not check for wells outside a specified range. This logic is housed within the plate object. All the classes in the microplate library are designed to be flexible in order to accommodate data in a variety of formats. The well object constructor accepts well IDs in each of the following formats:

Row	Column	Input
Integer	Integer	Row = 1 Column = 2
String	Integer	Row = "1" Column = 2
String	Integer	Row = "A" Column = 2
Integer	String	Row = 1 Column = "2"
String	String	Row = "A" Column = "2"
String	String	Row = "1" Column = "2"
String	String	"A2" Input must be [A-Za-z]+[0-9]+

The Well class also implements both hash code and equals functions in order to prevent duplicate wells within a single plate object. The well constructor is passed a flag holding the numerical data type. Once set, the numerical data type cannot be changed. The MicroFlex library supports wells containing all primitive numerical types for input and output as well as two immutable types: BigDecimal and BigInteger.

Author:: Jesse L. Mull

Field Summary

Fields
Modifier and Type Field and Description

static int BIGDECIMAL

static int BIGINTEGER

static int DOUBLE

static int INTEGER

Fields
Modifier and Type	Field and Description
`static int`	`BIGDECIMAL`
`static int`	`BIGINTEGER`
`static int`	`DOUBLE`
`static int`	`INTEGER`

Constructor Summary

Constructors
Constructor and Description
`WellPrecursor(int type, int row, int column)` Creates a new Well object from row and column integers.
`WellPrecursor(int type, int row, String column)` Creates a new Well object using the numerical type flag, row number and column string.
`WellPrecursor(int type, String wellID)` Creates a new Well object from a string holding the column and row values.
`WellPrecursor(int type, String row, int column)` Creates a new Well object using the numerical type flag, row string and column number.
`WellPrecursor(int type, String row, String column)` Creates a new Well object using the numerical type flag, row and column strings.
`WellPrecursor(WellPrecursor<T> well)` Clones a well without invoking clone.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`alphaBase()` Returns the alpha base value.
`int`	`column()` Returns the column number.
`int`	`compareTo(WellPrecursor<T> well)` Wells are ordered based on row and column number.
`abstract List<T>`	`data()`
`int`	`hashCode()` Hash code uses the row, column and ALPHA_BASE fields.
`String`	`index()` Returns the well index as a letter(s) number pair.
`int`	`row()` Returns the row number.
`String`	`rowString()` Returns the row ID.
`String`	`toString()` Returns row ID plus column number.
`int`	`type()` Returns the numerical data type as an integer value.
`String`	`typeString()` Returns the numerical data type as a String.

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

- Field Detail
  - DOUBLE
```
public static final int DOUBLE
```
    See Also:
    
    Constant Field Values
  - INTEGER
```
public static final int INTEGER
```
    See Also:
    
    Constant Field Values
  - BIGDECIMAL
```
public static final int BIGDECIMAL
```
    See Also:
    
    Constant Field Values
  - BIGINTEGER
```
public static final int BIGINTEGER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WellPrecursor
```
public WellPrecursor(int type,
                     int row,
                     int column)
```
    Creates a new Well object from row and column integers.
    
    Parameters:
    
    int - the well row
    
    int - the well column
  - WellPrecursor
```
public WellPrecursor(int type,
                     String row,
                     int column)
```
    Creates a new Well object using the numerical type flag, row string and column number.
    
    Parameters:
    
    int - the numerical data type
    
    String - the well row
    
    int - the well column
  - WellPrecursor
```
public WellPrecursor(int type,
                     int row,
                     String column)
```
    Creates a new Well object using the numerical type flag, row number and column string.
    
    Parameters:
    
    int - the numerical data type
    
    int - the well row
    
    String - the well column
    
    Throws:
    
    IllegalArgumentException - invalid column value
  - WellPrecursor
```
public WellPrecursor(int type,
                     String row,
                     String column)
```
    Creates a new Well object using the numerical type flag, row and column strings.
    
    Parameters:
    
    int - the numerical data type
    
    String - the well row
    
    String - the well column
    
    Throws:
    
    IllegalArgumentException - invalid column value
  - WellPrecursor
```
public WellPrecursor(int type,
                     String wellID)
```
    Creates a new Well object from a string holding the column and row values. The string must be in the format [a-ZA-Z]+[0-9]+
    
    Parameters:
    
    int - the numerical data type
    
    String - the well index
  - WellPrecursor
```
public WellPrecursor(WellPrecursor<T> well)
```
    Clones a well without invoking clone.
    
    Parameters:
    
    WellPrecursor - the well to clone
- Method Detail
  - index
```
public String index()
```
    Returns the well index as a letter(s) number pair.
    
    Returns:
    
    the index
  - type
```
public int type()
```
    Returns the numerical data type as an integer value.
    
    Returns:
    
    numerical data type integer
  - typeString
```
public String typeString()
```
    Returns the numerical data type as a String.
    
    Returns:
    
    numerical data type String
  - column
```
public int column()
```
    Returns the column number.
    
    Returns:
    
    the column number
  - row
```
public int row()
```
    Returns the row number.
    
    Returns:
    
    the row number
  - alphaBase
```
public int alphaBase()
```
    Returns the alpha base value.
    
    Returns:
    
    the alpha base value
  - rowString
```
public String rowString()
```
    Returns the row ID.
    
    Returns:
    
    row ID
  - toString
```
public String toString()
```
    Returns row ID plus column number.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    row ID plus column number
  - hashCode
```
public int hashCode()
```
    Hash code uses the row, column and ALPHA_BASE fields.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code
  - compareTo
```
public int compareTo(WellPrecursor<T> well)
              throws ClassCastException
```
    Wells are ordered based on row and column number.
    
    Specified by:
    
    compareTo in interface Comparable<WellPrecursor<T extends Number>>
    
    Parameters:
    
    WellPrecursor - the object for comparison
    
    Returns:
    
    this == well --> 0 this > well --> 1 this < well --> -1
    
    Throws:
    
    ClassCastException
  - data
```
public abstract List<T> data()
```

Class WellPrecursor<T extends Number>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOUBLE

INTEGER

BIGDECIMAL

BIGINTEGER

Constructor Detail

WellPrecursor

WellPrecursor

WellPrecursor

WellPrecursor

WellPrecursor

WellPrecursor

Method Detail

index

type

typeString

column

row

alphaBase

rowString

toString

hashCode

compareTo

data