org.proteios.core.data
Class BioMaterialEventData

java.lang.Object
  org.proteios.core.data.BasicData
      org.proteios.core.data.BioMaterialEventData

All Implemented Interfaces:

IdentifiableData

Direct Known Subclasses:

CreationEventData, GelImageAnalysisEventData, GelScanEventData, SeparationEventData, StainingEventData, UpdateEventData

public abstract class BioMaterialEventData
extends BasicData

This class is used to register events for measured biomaterials.

Version:

2.0

Author:

Nicklas

See Also:

BioMaterialEvent, Biomaterials overview

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Hibernate: class

table="`BioMaterialEvents`" lazy="false" discriminator-value="-1"

Hibernate: discriminator

column="`discriminator`" type="int"

Field Summary

static int

MAX_COMMENT_LENGTH The maximum length of the comment about this event.

Constructor Summary

BioMaterialEventData()

Method Summary

MeasuredBioMaterialData	getBioMaterial() Get the single biomaterial used by this event.
String	getComment() Get the comment about this event.
Date	getEntryDate() Get the date this event was added to the database.
Date	getEventDate() Get the date this event happened in the lab.
BioMaterialEventData	getPreviousBioMaterialEvent() This function returns the previous event that is directly linked to this event.
ProtocolData	getProtocol() Get the protocol used in this event.
SeparationMethodData	getSeparationMethod()
Map<MeasuredBioMaterialData,UsedQuantity>	getSources() Get a map containing the source biomaterials and the used quantity for this event.
Float	getUsedQuantityInMicroLiters() Get the used quantity of the biomaterial affected by this event, measured in microliters.
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	setComment(String comment)
void	setEntryDate(Date entryDate)
void	setEventDate(Date eventDate)
void	setPreviousBioMaterialEvent(BioMaterialEventData previousBioMaterialEvent) This function sets the previous event that is directly linked to this event.
void	setProtocol(ProtocolData protocol)
void	setSeparationMethod(SeparationMethodData separationMethod)
void	setUsedQuantityInMicroLiters(Float usedQuantity)
void	setUser(UserData user)

Methods inherited from class org.proteios.core.data.BasicData

equals, getId, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

MAX_COMMENT_LENGTH

public static final int MAX_COMMENT_LENGTH

The maximum length of the comment about this event.

See Also:

Constant Field Values

Constructor Detail

BioMaterialEventData

public BioMaterialEventData()

Method Detail

getBioMaterial

public MeasuredBioMaterialData getBioMaterial()

Get the single biomaterial used by this event.

Hibernate: many-to-one

column="`biomaterial_id`" not-null="false" outer-join="false" update="false"

setBioMaterial

public void setBioMaterial(MeasuredBioMaterialData bioMaterial)

getUsedQuantityInMicroLiters

public Float getUsedQuantityInMicroLiters()

Get the used quantity of the biomaterial affected by this event, measured in microliters. This can be both positive and negative.

Hibernate: property

column="`used_quantity`" type="float" not-null="false"

setUsedQuantityInMicroLiters

public void setUsedQuantityInMicroLiters(Float usedQuantity)

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="false" 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)

getEntryDate

public Date getEntryDate()

Get the date this event was added to the database.

Hibernate: property

column="`entry_date`" not-null="true" update="false"

setEntryDate

public void setEntryDate(Date entryDate)

getEventDate

public Date getEventDate()

Get the date this event happened in the lab.

Hibernate: property

column="`event_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<MeasuredBioMaterialData,UsedQuantity> getSources()

Get a map containing the source biomaterials and the used quantity for this event.

Hibernate: map

table="`BioMaterialEventSources`" lazy="true" cascade="delete"

Hibernate: index-many-to-many

column="`biomaterial_id`" class="org.proteios.core.data.MeasuredBioMaterialData"

Hibernate: collection-key

column="`event_id`"

Hibernate: collection-composite-element

class="org.proteios.core.data.UsedQuantity"

getSeparationMethod

public SeparationMethodData getSeparationMethod()

Hibernate: many-to-one

column="`separation_method_id`" cascade="delete" not-null="false" outer-join="false"

setSeparationMethod

public void setSeparationMethod(SeparationMethodData separationMethod)

getPreviousBioMaterialEvent

public BioMaterialEventData getPreviousBioMaterialEvent()

This function returns the previous event that is directly linked to this event. It can be used for linking series of separation events and possibly more.

Returns:

Returns the previousBioMaterialEvent.

Hibernate: many-to-one

column="`previousBioMaterialEventId`" not-null="false"

setPreviousBioMaterialEvent

public void setPreviousBioMaterialEvent(BioMaterialEventData previousBioMaterialEvent)

This function sets the previous event that is directly linked to this event. It can be used for linking series of separation events and possibly more

Parameters:

previousBioMaterialEvent - The previousBioMaterialEvent to set.