Package net.sf.basedb.core.data
Class BioMaterialEventData
- java.lang.Object
-
- net.sf.basedb.core.data.BasicData
-
- net.sf.basedb.core.data.BioMaterialEventData
-
- All Implemented Interfaces:
IdentifiableData
,LoggableData
,RegisteredData
public class BioMaterialEventData extends BasicData implements RegisteredData, LoggableData
This class is used to register events for measured biomaterials.- Version:
- 2.0
- Author:
- Nicklas
- See Also:
BioMaterialEvent
, Developer documentation: Biomaterials LIMS- Last modified
- $Date: 2015-11-02 08:46:40 +0100 (må, 02 nov 2015) $
- Hibernate: class
- table="`BioMaterialEvents`" lazy="true"
-
-
Field Summary
Fields Modifier and Type Field Description private PhysicalBioAssayData
bioassay
private MeasuredBioMaterialData
bioMaterial
private BioPlateEventParticipantData
bioPlateEventParticipant
private String
comment
private Date
entryDate
private Date
eventDate
private int
eventType
private HardwareData
hardware
private KitData
kit
static int
MAX_COMMENT_LENGTH
The maximum length of the comment about this event.private ProtocolData
protocol
private Map<BioMaterialData,BioMaterialEventSourceData>
sources
private Float
usedQuantity
private UserData
user
-
Constructor Summary
Constructors Constructor Description BioMaterialEventData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeasuredBioMaterialData
getBioMaterial()
Get the biomaterial produced or affected by this event.BioPlateEventParticipantData
getBioPlateEventParticipant()
Get the bioplate event that is the master event for this event.String
getComment()
Get the comment about this event.Date
getEntryDate()
Get the date this item was added to the database.Date
getEventDate()
Get the date this event happened in the lab.int
getEventType()
Get the type of event, 1=creation event, 2=hybridization event, 3=other eventHardwareData
getHardware()
Get the hardware used in this eventKitData
getKit()
Get the kit used in this event.PhysicalBioAssayData
getPhysicalBioAssay()
Get the physical bioassay that was created by this event.ProtocolData
getProtocol()
Get the protocol used in this event.Map<BioMaterialData,BioMaterialEventSourceData>
getSources()
Get a map containing information about the source biomaterials used in the event.Float
getUsedQuantity()
Get the used quantity of the biomaterial affected by this event.UserData
getUser()
Get the user that is responsible for this event, typically this is the user that entered the information in the database.void
setBioMaterial(MeasuredBioMaterialData bioMaterial)
void
setBioPlateEventParticipant(BioPlateEventParticipantData bioPlateEventParticipant)
void
setComment(String comment)
void
setEntryDate(Date entryDate)
void
setEventDate(Date eventDate)
void
setEventType(int eventType)
void
setHardware(HardwareData hardware)
void
setKit(KitData kit)
void
setPhysicalBioAssay(PhysicalBioAssayData bioassay)
void
setProtocol(ProtocolData protocol)
(package private) void
setSources(Map<BioMaterialData,BioMaterialEventSourceData> sources)
void
setUsedQuantity(Float usedQuantity)
void
setUser(UserData user)
-
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
-
-
-
-
Field Detail
-
entryDate
private Date entryDate
-
eventType
private int eventType
-
bioPlateEventParticipant
private BioPlateEventParticipantData bioPlateEventParticipant
-
bioMaterial
private MeasuredBioMaterialData bioMaterial
-
usedQuantity
private Float usedQuantity
-
bioassay
private PhysicalBioAssayData bioassay
-
user
private UserData user
-
protocol
private ProtocolData protocol
-
hardware
private HardwareData hardware
-
kit
private KitData kit
-
eventDate
private Date eventDate
-
MAX_COMMENT_LENGTH
public static final int MAX_COMMENT_LENGTH
The maximum length of the comment about this event.- See Also:
- Constant Field Values
-
comment
private String comment
-
sources
private Map<BioMaterialData,BioMaterialEventSourceData> sources
-
-
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 interfaceRegisteredData
-
setEntryDate
public void setEntryDate(Date entryDate)
-
getEventType
public int getEventType()
Get the type of event, 1=creation event, 2=hybridization event, 3=other event- Hibernate: property
- column="`event_type`" type="int" not-null="true" update="false"
-
setEventType
public void setEventType(int eventType)
-
getBioPlateEventParticipant
public BioPlateEventParticipantData getBioPlateEventParticipant()
Get the bioplate event that is the master event for this event. Null if no bioplate event exists for this event.- Since:
- 2.17
- Hibernate: many-to-one
- column="`bioplateeventparticipant_id`" not-null="false" outer-join="false" update="false"
-
setBioPlateEventParticipant
public void setBioPlateEventParticipant(BioPlateEventParticipantData bioPlateEventParticipant)
-
getBioMaterial
public MeasuredBioMaterialData getBioMaterial()
Get the biomaterial produced or affected by this event.- Hibernate: many-to-one
- column="`biomaterial_id`" not-null="false" outer-join="false" update="false"
-
setBioMaterial
public void setBioMaterial(MeasuredBioMaterialData bioMaterial)
-
getUsedQuantity
public Float getUsedQuantity()
Get the used quantity of the biomaterial affected by this event. This can be both positive and negative.- Hibernate: property
- column="`used_quantity`" type="float" not-null="false"
-
setUsedQuantity
public void setUsedQuantity(Float usedQuantity)
-
getPhysicalBioAssay
public PhysicalBioAssayData getPhysicalBioAssay()
Get the physical bioassay that was created by this event.- Hibernate: many-to-one
- column="`physicalbioassay_id`" not-null="false" outer-join="false" update="false"
-
setPhysicalBioAssay
public void setPhysicalBioAssay(PhysicalBioAssayData bioassay)
-
getUser
public UserData getUser()
Get the user that is responsible for this event, typically this is the user that entered the information in the database.- Hibernate: many-to-one
- column="`user_id`" not-null="true" outer-join="false" update="false"
-
setUser
public void setUser(UserData user)
-
getProtocol
public ProtocolData getProtocol()
Get the protocol used in this event.- Hibernate: many-to-one
- column="`protocol_id`" not-null="false" outer-join="false"
-
setProtocol
public void setProtocol(ProtocolData protocol)
-
getHardware
public HardwareData getHardware()
Get the hardware used in this event- Hibernate: many-to-one
- column="`hardware_id`" not-null="false" outer-join="false"
-
setHardware
public void setHardware(HardwareData hardware)
-
getKit
public KitData getKit()
Get the kit used in this event.- Since:
- 3.7
- Hibernate: many-to-one
- column="`kit_id`" not-null="false" outer-join="false"
-
setKit
public void setKit(KitData kit)
-
getEventDate
public Date getEventDate()
Get the date this event happened in the lab.- Hibernate: property
- column="`event_date`" type="date" not-null="false"
-
setEventDate
public void setEventDate(Date eventDate)
-
getComment
public String getComment()
Get the comment about this event.- Hibernate: property
- column="`comment`" type="text" not-null="false"
-
setComment
public void setComment(String comment)
-
getSources
public Map<BioMaterialData,BioMaterialEventSourceData> getSources()
Get a map containing information about the source biomaterials used in the event. This is only used for events that create child biomaterial or physical bioassay. This is the inverse end. SeeBioMaterialEventSourceData.getEvent()
- Since:
- 3.0
- Hibernate: map
- inverse="true" lazy="true" cascade="all"
- Hibernate: index-many-to-many
- column="`biomaterial_id`" class="net.sf.basedb.core.data.BioMaterialData"
- Hibernate: collection-key
- column="`event_id`"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.BioMaterialEventSourceData"
-
setSources
void setSources(Map<BioMaterialData,BioMaterialEventSourceData> sources)
-
-