3.0.2: 2012-01-25

net.sf.basedb.core.data
Class MeasuredBioMaterialData

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.BioMaterialData
                          extended by net.sf.basedb.core.data.MeasuredBioMaterialData
All Implemented Interfaces:
AnnotatableData, IdentifiableData, LoggableData, NameableData, OwnableData, RemovableData, ShareableData, SubtypableData
Direct Known Subclasses:
ExtractData, SampleData

public abstract class MeasuredBioMaterialData
extends BioMaterialData

This class is the root class for measured biomaterials, ie biomaterials for where the quantity is tracked.

Version:
2.0
Author:
Nicklas
See Also:
MeasuredBioMaterial, Developer documentation: Biomaterials LIMS
Last modified
$Date: 2011-10-21 13:15:41 +0200 (Fri, 21 Oct 2011) $
Hibernate: subclass
discriminator-value="-1" lazy="false"

Field Summary
private  BioWellData bioWell
           
private  BioMaterialEventData creationEvent
           
private  Set<BioMaterialEventData> events
           
private  Float originalQuantity
           
private  BioMaterialData parent
           
private  Integer parentType
           
private  Float remainingQuantity
           
 
Fields inherited from class net.sf.basedb.core.data.BioMaterialData
MAX_EXTERNAL_ID_LENGTH
 
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Constructor Summary
MeasuredBioMaterialData()
           
 
Method Summary
 BioWellData getBioWell()
          Get the bio well.
 BioMaterialEventData getCreationEvent()
          Get the event that created this biomaterial.
(package private)  Set<BioMaterialEventData> getEvents()
          This is the inverse end.
 Float getOriginalQuantity()
          Get the original quantity of the biomaterial.
 BioMaterialData getParent()
          Get the parent biomaterial.
 Integer getParentType()
          Get the type of the parent item.
 Float getRemainingQuantity()
          Get the remaining quantity of the biomaterial.
 void setBioWell(BioWellData bioWell)
           
(package private)  void setCreationEvent(BioMaterialEventData creationEvent)
           
(package private)  void setEvents(Set<BioMaterialEventData> events)
           
 void setOriginalQuantity(Float originalQuantity)
           
 void setParent(BioMaterialData parent)
           
 void setParentType(Integer parentType)
           
 void setRemainingQuantity(Float remainingQuantity)
           
 
Methods inherited from class net.sf.basedb.core.data.BioMaterialData
getBioMaterialLists, getChildCreationEvents, getChildren, getExternalId, getItemSubtype, setBioMaterialLists, setChildCreationEvents, setChildren, setExternalId, setItemSubtype
 
Methods inherited from class net.sf.basedb.core.data.AnnotatedData
getAnnotationSet, 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

parent

private BioMaterialData parent

originalQuantity

private Float originalQuantity

remainingQuantity

private Float remainingQuantity

parentType

private Integer parentType

creationEvent

private BioMaterialEventData creationEvent

events

private Set<BioMaterialEventData> events

bioWell

private BioWellData bioWell
Constructor Detail

MeasuredBioMaterialData

public MeasuredBioMaterialData()
Method Detail

getParent

public BioMaterialData getParent()
Get the parent biomaterial. Used when a biomaterial has a single parent item.

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

setParent

public void setParent(BioMaterialData parent)

getOriginalQuantity

public Float getOriginalQuantity()
Get the original quantity of the biomaterial.

Hibernate: property
column="`original_quantity`" type="float" not-null="false"

setOriginalQuantity

public void setOriginalQuantity(Float originalQuantity)

getRemainingQuantity

public Float getRemainingQuantity()
Get the remaining quantity of the biomaterial.

Hibernate: property
column="`remaining_quantity`" type="float" not-null="false" update="false"

setRemainingQuantity

public void setRemainingQuantity(Float remainingQuantity)

getParentType

public Integer getParentType()
Get the type of the parent item. Null if the biomaterial doesn't have any parents.

Since:
3.0
Hibernate: property
column="`parent_type`" type="int" not-null="false"

setParentType

public void setParentType(Integer parentType)

getCreationEvent

public BioMaterialEventData getCreationEvent()
Get the event that created this biomaterial. Mapping is defined in hibernate-properties-MeasuredBioMaterialData.xml since XDoclet cannot generate it.


setCreationEvent

void setCreationEvent(BioMaterialEventData creationEvent)

getEvents

Set<BioMaterialEventData> getEvents()
This is the inverse end.

See Also:
BioMaterialEventData.getBioMaterial()
Hibernate: set
lazy="true" inverse="true" cascade="delete"
Hibernate: collection-key
column="`biomaterial_id`"
Hibernate: collection-one-to-many
class="net.sf.basedb.core.data.BioMaterialEventData"

setEvents

void setEvents(Set<BioMaterialEventData> events)

getBioWell

public BioWellData getBioWell()
Get the bio well.

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

setBioWell

public void setBioWell(BioWellData bioWell)

3.0.2: 2012-01-25