net.sf.basedb.core.data
Class MeasuredBioMaterialData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.OwnedData
          net.sf.basedb.core.data.SharedData
              net.sf.basedb.core.data.CommonData
                  net.sf.basedb.core.data.AnnotatedData
                      net.sf.basedb.core.data.BioMaterialData
                          net.sf.basedb.core.data.MeasuredBioMaterialData

All Implemented Interfaces:

AnnotatableData, IdentifiableData, LoggableData, NameableData, OwnableData, RemovableData, ShareableData

Direct Known Subclasses:

ExtractData, LabeledExtractData, 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, Biomaterials overview

Last modified

$Date: 2009-10-08 10:46:51 +0200 (Thu, 08 Oct 2009) $

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 boolean	pooled
private Float	remainingQuantity
private Set<BioMaterialSourceEventData>	sourceEvents

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.
Float	getRemainingQuantity() Get the remaining quantity of the biomaterial.
(package private) Set<BioMaterialSourceEventData>	getSourceEvents() This is the inverse end.
boolean	isPooled() If the biomaterial was created by pooling other biomaterials of the same type or not.
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	setPooled(boolean pooled)
void	setRemainingQuantity(Float remainingQuantity)
(package private) void	setSourceEvents(Set<BioMaterialSourceEventData> sourceEvents)

Methods inherited from class net.sf.basedb.core.data.BioMaterialData

getBioMaterialLists, getChildren, getExternalId, setBioMaterialLists, setChildren, setExternalId

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

pooled

private boolean pooled

creationEvent

private BioMaterialEventData creationEvent

events

private Set<BioMaterialEventData> events

sourceEvents

private Set<BioMaterialSourceEventData> sourceEvents

bioWell

private BioWellData bioWell

Constructor Detail

MeasuredBioMaterialData

public MeasuredBioMaterialData()

Method Detail

getParent

public BioMaterialData getParent()

Get the parent biomaterial. Used for non-pooled biomaterials. The core must add logic to check that only a biomaterial of the parent type is linked.

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)

isPooled

public boolean isPooled()

If the biomaterial was created by pooling other biomaterials of the same type or not.

Hibernate: property

column="`pooled`" type="boolean" not-null="false"

setPooled

public void setPooled(boolean pooled)

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)

getSourceEvents

Set<BioMaterialSourceEventData> getSourceEvents()

This is the inverse end.

See Also:

BioMaterialEventData.getSources()

Hibernate: set

table="`BioMaterialEventSources`" lazy="true" inverse="true"

Hibernate: collection-key

column="`biomaterial_id`"

Hibernate: collection-composite-element

class="net.sf.basedb.core.data.BioMaterialSourceEventData" hibernate.collection-many-to-many column="`event_id`" class="net.sf.basedb.core.data.BioMaterialEventData"

setSourceEvents

void setSourceEvents(Set<BioMaterialSourceEventData> sourceEvents)

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)