net.sf.basedb.core.data
Class BioPlateData

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.BioPlateData

All Implemented Interfaces:

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

public class BioPlateData
extends AnnotatedData

This class holds information about a bioplate

Version:

2.10

Author:

martin

See Also:

BioPlate, Biomaterials overview

Last modified

$Date: 2008-11-27 16:33:55 +0100 (Thu, 27 Nov 2008) $

Hibernate: class

table="`BioPlates`" lazy="false"

Field Summary

private String	barcode
private BioPlateTypeData	bioPlateType
private Map<PlateCoordinate,BioWellData>	bioWells
private boolean	destroyed
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.
private PlateGeometryData	plateGeometry

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

BioPlateData()

Method Summary

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.
(package private) Set<BioPlateEventParticipantData>	getEventParticipants() This is the inverse end.
String	getExternalId() Get the external id for the biomaterial
int	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.
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)
(package private) void	setEventParticipants(Set<BioPlateEventParticipantData> eventParticipants)
void	setExternalId(String externalId)
void	setFreeWells(int freeWells)
void	setFreezer(HardwareData freezer)
void	setPlateGeometry(PlateGeometryData plateGeometry)
void	updateFreeWells(int diff) Update the number of free wells with the given difference

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

MAX_EXTERNAL_ID_LENGTH

public static final int MAX_EXTERNAL_ID_LENGTH

The maximum length of the external id that can be stored in the database.

See Also:

setExternalId(String), Constant Field Values

externalId

private String externalId

MAX_BARCODE_LENGTH

public static final int MAX_BARCODE_LENGTH

The maximum length of the barcode that can be stored in the database.

See Also:

setBarcode(String), Constant Field Values

barcode

private String barcode

destroyed

private boolean destroyed

plateGeometry

private PlateGeometryData plateGeometry

freezer

private HardwareData freezer

bioPlateType

private BioPlateTypeData bioPlateType

freeWells

private int freeWells

bioWells

private Map<PlateCoordinate,BioWellData> bioWells

eventParticipants

private Set<BioPlateEventParticipantData> eventParticipants

Constructor Detail

BioPlateData

public BioPlateData()

Method Detail

getExternalId

public String getExternalId()

Get the external id for the biomaterial

Hibernate: property

column="`external_id`" type="string" length="255" not-null="false"

setExternalId

public void setExternalId(String externalId)

getBarcode

public String 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

public void setBarcode(String barcode)

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)

getPlateGeometry

public PlateGeometryData getPlateGeometry()

The geometry of this plate type.

Hibernate: many-to-one

column="`plategeometry_id`" not-null="true" outer-join="false" update="false"

setPlateGeometry

public void setPlateGeometry(PlateGeometryData plateGeometry)

getFreezer

public HardwareData getFreezer()

Get the hardware, ie. freezer where the plate is kept.

Hibernate: many-to-one

column="`hardware_id`" not-null="false" outer-join="false"

setFreezer

public void setFreezer(HardwareData freezer)

getBioPlateType

public BioPlateTypeData 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

public void setBioPlateType(BioPlateTypeData bioPlateType)

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

public Map<PlateCoordinate,BioWellData> 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

void setBioWells(Map<PlateCoordinate,BioWellData> bioWells)

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

void setEventParticipants(Set<BioPlateEventParticipantData> eventParticipants)