3.2.4: 2013-12-06

net.sf.basedb.core.data
Class BioPlateData

java.lang.Object
  extended by net.sf.basedb.core.data.BasicData
      extended by net.sf.basedb.core.data.OwnedData
          extended by net.sf.basedb.core.data.SharedData
              extended by net.sf.basedb.core.data.CommonData
                  extended by net.sf.basedb.core.data.AnnotatedData
                      extended by net.sf.basedb.core.data.BioPlateData
All Implemented Interfaces:
AnnotatableData, IdentifiableData, LoggableData, NameableData, OwnableData, RegisteredData, RemovableData, ShareableData

public class BioPlateData
extends AnnotatedData
implements RegisteredData

This class holds information about a bioplate

Version:
2.10
Author:
martin
See Also:
BioPlate, Developer documentation: Biomaterials LIMS
Last modified
$Date: 2008-11-27 16:33:55 +0100 (Thu, 27 Nov 2008) $
Hibernate: class
table="`BioPlates`" lazy="false"

Field Summary
private  String barcode
           
private  BioPlateTypeData bioPlateType
           
private  Map<PlateCoordinate,BioWellData> bioWells
           
private  boolean destroyed
           
private  Date entryDate
           
private  Date eventDate
           
private  Set<BioPlateEventParticipantData> eventParticipants
           
private  String externalId
           
private  int freeWells
           
private  HardwareData freezer
           
static int MAX_BARCODE_LENGTH
          The maximum length of the barcode that can be stored in the database.
static int MAX_EXTERNAL_ID_LENGTH
          The maximum length of the external id that can be stored in the database.
static int MAX_POSITION_LENGTH
          The maximum length of the position coordinate that can be stored in the database.
static int MAX_SECTION_LENGTH
          The maximum length of the section coordinate that can be stored in the database.
static int MAX_TRAY_LENGTH
          The maximum length of the tray coordinate that can be stored in the database.
private  PlateGeometryData plateGeometry
           
private  String position
           
private  String section
           
private  String tray
           
 
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Constructor Summary
BioPlateData()
           
 
Method Summary
 String getBarcode()
          Get the barcode for the bioplate.
 BioPlateTypeData getBioPlateType()
          Get the type of the bioplate.
 Map<PlateCoordinate,BioWellData> getBioWells()
          The wells on this plate.
 Date getEntryDate()
          Get the date this item was added to the database.
 Date getEventDate()
          Get the date this plate was created in the lab.
(package private)  Set<BioPlateEventParticipantData> getEventParticipants()
          This is the inverse end.
 String getExternalId()
          Get the external id for the biomaterial
 int getFreeWells()
          Get the number of wells that are free on the bioplate.
 HardwareData getFreezer()
          Get the hardware, ie. freezer where the plate is kept.
 PlateGeometryData getPlateGeometry()
          The geometry of this plate type.
 String getPosition()
          Get the position in the storage location were the bioplate is stored.
 String getSection()
          Get the section in the storage location were the bioplate is stored.
 String getTray()
          Get the tray in the storage location were the bioplate is stored.
 boolean isDestroyed()
          If the plate has been destroyed.
 void setBarcode(String barcode)
           
 void setBioPlateType(BioPlateTypeData bioPlateType)
           
(package private)  void setBioWells(Map<PlateCoordinate,BioWellData> bioWells)
           
 void setDestroyed(boolean destroyed)
           
 void setEntryDate(Date entryDate)
           
 void setEventDate(Date eventDate)
           
(package private)  void setEventParticipants(Set<BioPlateEventParticipantData> eventParticipants)
           
 void setExternalId(String externalId)
           
 void setFreeWells(int freeWells)
           
 void setFreezer(HardwareData freezer)
           
 void setPlateGeometry(PlateGeometryData plateGeometry)
           
 void setPosition(String position)
           
 void setSection(String section)
           
 void setTray(String tray)
           
 void updateFreeWells(int diff)
          Update the number of free wells with the given difference
 
Methods inherited from class net.sf.basedb.core.data.AnnotatedData
getAnnotations, getAnnotationSet, setAnnotations, setAnnotationSet
 
Methods inherited from class net.sf.basedb.core.data.CommonData
getDescription, getName, isRemoved, setDescription, setName, setRemoved
 
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
 
Methods inherited from class net.sf.basedb.core.data.OwnedData
getOwner, setOwner
 
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
 
Methods inherited from interface net.sf.basedb.core.data.OwnableData
getOwner, setOwner
 

Field Detail

entryDate

private Date entryDate

MAX_EXTERNAL_ID_LENGTH

public static final int MAX_EXTERNAL_ID_LENGTH
The maximum length of the external id that can be stored in the database.

See Also:
setExternalId(String), Constant Field Values

externalId

private String externalId

MAX_BARCODE_LENGTH

public static final int MAX_BARCODE_LENGTH
The maximum length of the barcode that can be stored in the database.

See Also:
setBarcode(String), Constant Field Values

barcode

private String barcode

destroyed

private boolean destroyed

eventDate

private Date eventDate

plateGeometry

private PlateGeometryData plateGeometry

freezer

private HardwareData freezer

MAX_SECTION_LENGTH

public static final int MAX_SECTION_LENGTH
The maximum length of the section coordinate that can be stored in the database.

Since:
3.2
See Also:
setSection(String), Constant Field Values

section

private String section

MAX_TRAY_LENGTH

public static final int MAX_TRAY_LENGTH
The maximum length of the tray coordinate that can be stored in the database.

Since:
3.2
See Also:
setTray(String), Constant Field Values

tray

private String tray

MAX_POSITION_LENGTH

public static final int MAX_POSITION_LENGTH
The maximum length of the position coordinate that can be stored in the database.

Since:
3.2
See Also:
setPosition(String), Constant Field Values

position

private String position

bioPlateType

private BioPlateTypeData bioPlateType

freeWells

private int freeWells

bioWells

private Map<PlateCoordinate,BioWellData> bioWells

eventParticipants

private Set<BioPlateEventParticipantData> eventParticipants
Constructor Detail

BioPlateData

public BioPlateData()
Method Detail

getEntryDate

public Date getEntryDate()
Description copied from interface: RegisteredData
Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:
getEntryDate in interface RegisteredData
Since:
3.1

setEntryDate

public void setEntryDate(Date entryDate)

getExternalId

public String getExternalId()
Get the external id for the biomaterial

Hibernate: property
column="`external_id`" type="string" length="255" not-null="false"

setExternalId

public void setExternalId(String externalId)

getBarcode

public String getBarcode()
Get the barcode for the bioplate. It is not required and doesn't have to be unique.

Hibernate: property
column="`barcode`" type="string" length="255" not-null="false"

setBarcode

public void setBarcode(String barcode)

isDestroyed

public boolean isDestroyed()
If the plate has been destroyed.

Since:
2.16
Hibernate: property
column="`destroyed`" type="boolean" not-null="true"

setDestroyed

public void setDestroyed(boolean destroyed)

getEventDate

public Date getEventDate()
Get the date this plate was created in the lab.

Since:
3.1
Hibernate: property
column="`event_date`" type="date" not-null="false"

setEventDate

public void setEventDate(Date eventDate)

getPlateGeometry

public PlateGeometryData getPlateGeometry()
The geometry of this plate type.

Hibernate: many-to-one
column="`plategeometry_id`" not-null="true" outer-join="false" update="false"

setPlateGeometry

public void setPlateGeometry(PlateGeometryData plateGeometry)

getFreezer

public HardwareData getFreezer()
Get the hardware, ie. freezer where the plate is kept. NOTE! Since BASE 3.2 we use the term "storage location" instead, but for backwards compatibility we can't change method names in the API.

Hibernate: many-to-one
column="`hardware_id`" not-null="false" outer-join="false"

setFreezer

public void setFreezer(HardwareData freezer)

getSection

public String getSection()
Get the section in the storage location were the bioplate is stored.

Since:
3.2
Hibernate: property
column="`section`" type="string" length="255" not-null="false"

setSection

public void setSection(String section)

getTray

public String getTray()
Get the tray in the storage location were the bioplate is stored.

Since:
3.2
Hibernate: property
column="`tray`" type="string" length="255" not-null="false"

setTray

public void setTray(String tray)

getPosition

public String getPosition()
Get the position in the storage location were the bioplate is stored.

Since:
3.2
Hibernate: property
column="`position`" type="string" length="255" not-null="false"

setPosition

public void setPosition(String position)

getBioPlateType

public BioPlateTypeData getBioPlateType()
Get the type of the bioplate.

Since:
2.16
Hibernate: many-to-one
column="`bioplatetype_id`" not-null="true" outer-join="false" update="false"

setBioPlateType

public void setBioPlateType(BioPlateTypeData bioPlateType)
Since:
2.16

getFreeWells

public int getFreeWells()
Get the number of wells that are free on the bioplate.

Since:
2.17
Hibernate: property
column="`free_wells`" type="int" not-null="true"

setFreeWells

public void setFreeWells(int freeWells)

updateFreeWells

public void updateFreeWells(int diff)
Update the number of free wells with the given difference

Since:
2.17

getBioWells

public Map<PlateCoordinate,BioWellData> getBioWells()
The wells on this plate. This is the inverse end.

See Also:
BioWellData.getBioPlate()
Hibernate: map
lazy="true" inverse="true" cascade="all"
Hibernate: collection-key
column="`bioplate_id`"
Hibernate: collection-composite-index
class="net.sf.basedb.core.data.PlateCoordinate"
Hibernate: collection-one-to-many
class="net.sf.basedb.core.data.BioWellData"

setBioWells

void setBioWells(Map<PlateCoordinate,BioWellData> bioWells)

getEventParticipants

Set<BioPlateEventParticipantData> getEventParticipants()
This is the inverse end.

Since:
2.17
See Also:
BioPlateEventParticipantData.getBioPlate()
Hibernate: set
lazy="true" inverse="true" cascade="delete"
Hibernate: collection-key
column="`bioplate_id`"
Hibernate: collection-one-to-many
class="net.sf.basedb.core.data.BioPlateEventParticipantData"

setEventParticipants

void setEventParticipants(Set<BioPlateEventParticipantData> eventParticipants)

3.2.4: 2013-12-06