com.github.jessemull.microflexinteger.plate

Class WellList

java.lang.Object

com.github.jessemull.microflexinteger.plate.WellList

All Implemented Interfaces:

Comparable<WellList>, Iterable<WellIndex>

public class WellList
extends Object
implements Iterable<WellIndex>, Comparable<WellList>

Internal data structure to hold lists of well indices for well sets or plates. The list of well indices prevents redundant data storage for the wells within a well set or plate object.

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
WellList() Creates a new well list object;
WellList(Collection<WellIndex> collection) Creates a new well list from a collection of indices.
WellList(Collection<WellIndex> collection, String label) Creates a new well list from a collection of indices and a label.
WellList(String label) Creates a new well list object with the label.
WellList(WellIndex[] array) Creates a new well list from an array.
WellList(WellIndex[] array, String label) Creates a new well list from an array of indices and a label.
WellList(WellList list) Creates a new well list from an existing well list.

Method Summary

Modifier and Type	Method and Description
void	add(WellIndex index) Adds a well index.
int	compareTo(WellList list) Plates are ordered using the size, data type, label and number of sets.
boolean	equals(Object object) Lists are equivalent if they contain the same wells.
boolean	equalsSet(WellSet set) Returns true if the well set contains the same wells.
int	hashCode() Hash code uses the label and the indices in the list.
Set<WellIndex>	indices() Returns the list of indices.
Iterator<WellIndex>	iterator() Returns a well index iterator.
String	label() Returns the list name.
void	remove(WellIndex index) Removes a well index.
void	setLabel(String label) Sets the list name.
int	size() Returns the size of the list.
String	toString() Return a string containing the label and indices.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WellList

public WellList()

Creates a new well list object;

WellList

public WellList(String label)

Creates a new well list object with the label.

Parameters:

label -

WellList

public WellList(Collection<WellIndex> collection)

Creates a new well list from a collection of indices.

Parameters:

Collection - collection of well indices

WellList

public WellList(Collection<WellIndex> collection,
                String label)

Creates a new well list from a collection of indices and a label.

Parameters:

Collection - collection of well indices

String - the list label

WellList

public WellList(WellIndex[] array)

Creates a new well list from an array.

Parameters:

WellIndex[] - array of well indices

WellList

public WellList(WellIndex[] array,
                String label)

Creates a new well list from an array of indices and a label.

Parameters:

WellIndex[] - array of well indices

String - the list label

WellList

public WellList(WellList list)

Creates a new well list from an existing well list.

Parameters:

WellList - the well list

Method Detail

add

public void add(WellIndex index)

Adds a well index.

Parameters:

WellIndex - the well index

remove

public void remove(WellIndex index)

Removes a well index.

Parameters:

WellIndex - the well index

setLabel

public void setLabel(String label)

Sets the list name.

Parameters:

String - list name

indices

public Set<WellIndex> indices()

Returns the list of indices.

Returns:

the list of indices

label

public String label()

Returns the list name.

Returns:

the list name

size

public int size()

Returns the size of the list.

Returns:

list size

iterator

public Iterator<WellIndex> iterator()

Returns a well index iterator.

Specified by:

iterator in interface Iterable<WellIndex>

Returns:

Iterator iterator()

equalsSet

public boolean equalsSet(WellSet set)

Returns true if the well set contains the same wells.

Parameters:

WellSet - the well set

Returns:

true if the set and list have equivalent well indices

toString

public String toString()

Return a string containing the label and indices.

Overrides:

toString in class Object

Returns:

string holding label and indices

equals

public boolean equals(Object object)

Lists are equivalent if they contain the same wells.

Overrides:

equals in class Object

Parameters:

Object - the object

Returns:

true if equal, false otherwise

hashCode

public int hashCode()

Hash code uses the label and the indices in the list.

Overrides:

hashCode in class Object

Returns:

the hash code

compareTo

public int compareTo(WellList list)
              throws ClassCastException

Plates are ordered using the size, data type, label and number of sets.

Specified by:

compareTo in interface Comparable<WellList>

Parameters:

PlateInteger - the plate for comparison

Returns:

this == plate --> 0 this > plate --> 1 this < plate --> -1

Throws:

ClassCastException