Package net.sf.basedb.core.data
Class 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
Fields Modifier and Type Field Description 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
Constructors Constructor Description BioPlateData()
-
Method Summary
Modifier and Type Method Description 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 biomaterialint
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 differenceMethods 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, getRemovedBy, setDescription, setName, setRemovedBy
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
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 Details
-
entryDate
-
MAX_EXTERNAL_ID_LENGTH
public static final int MAX_EXTERNAL_ID_LENGTHThe maximum length of the external id that can be stored in the database.- See Also:
setExternalId(String)
, Constant Field Values
-
externalId
-
MAX_BARCODE_LENGTH
public static final int MAX_BARCODE_LENGTHThe maximum length of the barcode that can be stored in the database.- See Also:
setBarcode(String)
, Constant Field Values
-
barcode
-
destroyed
private boolean destroyed -
eventDate
-
plateGeometry
-
freezer
-
MAX_SECTION_LENGTH
public static final int MAX_SECTION_LENGTHThe maximum length of the section coordinate that can be stored in the database.- Since:
- 3.2
- See Also:
setSection(String)
, Constant Field Values
-
section
-
MAX_TRAY_LENGTH
public static final int MAX_TRAY_LENGTHThe maximum length of the tray coordinate that can be stored in the database.- Since:
- 3.2
- See Also:
setTray(String)
, Constant Field Values
-
tray
-
MAX_POSITION_LENGTH
public static final int MAX_POSITION_LENGTHThe maximum length of the position coordinate that can be stored in the database.- Since:
- 3.2
- See Also:
setPosition(String)
, Constant Field Values
-
position
-
bioPlateType
-
freeWells
private int freeWells -
bioWells
-
eventParticipants
-
-
Constructor Details
-
BioPlateData
public BioPlateData()
-
-
Method Details
-
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 interfaceRegisteredData
- Since:
- 3.1
-
setEntryDate
-
getExternalId
Get the external id for the biomaterial- Hibernate: property
- column="`external_id`" type="string" length="255" not-null="false"
-
setExternalId
-
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
-
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
Get the date this plate was created in the lab.- Since:
- 3.1
- Hibernate: property
- column="`event_date`" type="date" not-null="false"
-
setEventDate
-
getPlateGeometry
The geometry of this plate type.- Hibernate: many-to-one
- column="`plategeometry_id`" not-null="true" outer-join="false" update="false"
-
setPlateGeometry
-
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
-
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
-
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
-
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
-
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
- 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
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
-
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
-