com.github.jessemull.microflexinteger.plate

Class WellIndex

java.lang.Object

com.github.jessemull.microflexinteger.plate.WellIndex

All Implemented Interfaces:

Comparable<WellIndex>

public class WellIndex
extends Object
implements Comparable<WellIndex>

A wrapper for a row and column index pair.

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
WellIndex(int row, int column) Creates a new well index object.

Method Summary

Modifier and Type	Method and Description
int	column() Returns the column index.
int	compareTo(WellIndex index) Compares two well indices.
boolean	equals(Object object) Indicies with the same row and column are equivalent.
int	hashCode() Hash code uses the row and column.
int	row() Returns the row index.
String	rowString() Returns the row ID.
String	toString() Returns a string containing the well.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WellIndex

public WellIndex(int row,
                 int column)

Creates a new well index object.

Parameters:

int - the row index

int - the column index

Method Detail

row

public int row()

Returns the row index.

Returns:

the row index

column

public int column()

Returns the column index.

Returns:

the column index

compareTo

public int compareTo(WellIndex index)

Compares two well indices.

Specified by:

compareTo in interface Comparable<WellIndex>

Returns:

1 -> input > this -1 -> input < this 0 -> input == this

toString

public String toString()

Returns a string containing the well.

Overrides:

toString in class Object

rowString

public String rowString()

Returns the row ID.

Returns:

row ID

equals

public boolean equals(Object object)

Indicies with the same row and column are equivalent.

Overrides:

equals in class Object

Parameters:

Object - the object

Returns:

true if equal, false otherwise

hashCode

public int hashCode()

Hash code uses the row and column.

Overrides:

hashCode in class Object

Returns:

the hash code