Package net.sf.basedb.core.data
Class PlateData
-
- All Implemented Interfaces:
AnnotatableData
,IdentifiableData
,LoggableData
,NameableData
,OwnableData
,RegisteredData
,RemovableData
,ShareableData
public class PlateData extends AnnotatedData implements RegisteredData
This class holds information about a plate.- Version:
- 2.0
- Author:
- Nicklas
- See Also:
Plate
, Developer documentation: Array LIMS (plates)- Last modified
- $Date: 2012-09-14 09:28:35 +0200 (fr, 14 sep 2012) $
- Hibernate: class
- table="`Plates`" lazy="false"
-
-
Field Summary
Fields Modifier and Type Field Description private Set<ArrayDesignPlateData>
arrayDesigns
private String
barcode
private Set<PlateData>
children
private int
destinationIndex
private boolean
destroyed
private Date
entryDate
private Map<PlateEventTypeData,PlateEventData>
events
static int
MAX_BARCODE_LENGTH
The maximum length of the barcode that can be stored in the database.private Map<PlateData,Integer>
parents
private Set<PlateData>
parentSet
private PlateMappingData
plateMapping
private PlateTypeData
plateType
private Map<PlateCoordinate,WellData>
wells
-
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
-
Constructor Summary
Constructors Constructor Description PlateData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) Set<ArrayDesignPlateData>
getArrayDesigns()
Used by Hibernate to link with the arraydesign for this plate.String
getBarcode()
Get the barcode for the plate.(package private) Set<PlateData>
getChildren()
The childs plates created by plate mappings.int
getDestinationIndex()
If the plate was created by a plate mapping, this is the index of this plate in the list of created plates.Date
getEntryDate()
Get the date this item was added to the database.Map<PlateEventTypeData,PlateEventData>
getEvents()
The event for this plate.Map<PlateData,Integer>
getParents()
If the plate was created by aPlateMappingData
the source plates are kept here.(package private) Set<PlateData>
getParentSet()
Duplicate ofgetParents()
but with a set instead of a map.PlateMappingData
getPlateMapping()
If this plate was created by a plate mapping, it is linked here.PlateTypeData
getPlateType()
The plate type of this plate.Map<PlateCoordinate,WellData>
getWells()
The wells on this plate.boolean
isDestroyed()
If the plate has been destroyed.(package private) void
setArrayDesigns(Set<ArrayDesignPlateData> arrayDesigns)
void
setBarcode(String barcode)
(package private) void
setChildren(Set<PlateData> children)
void
setDestinationIndex(int destinationIndex)
void
setDestroyed(boolean destroyed)
void
setEntryDate(Date entryDate)
(package private) void
setEvents(Map<PlateEventTypeData,PlateEventData> events)
(package private) void
setParents(Map<PlateData,Integer> parents)
(package private) void
setParentSet(Set<PlateData> parentSet)
void
setPlateMapping(PlateMappingData plateMapping)
void
setPlateType(PlateTypeData plateType)
(package private) void
setWells(Map<PlateCoordinate,WellData> wells)
-
Methods inherited from class net.sf.basedb.core.data.AnnotatedData
getAnnotations, getAnnotationSet, setAnnotations, setAnnotationSet
-
Methods inherited from class net.sf.basedb.core.data.CommonData
getDescription, getName, getRemovedBy, setDescription, setName, setRemovedBy
-
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
-
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
-
entryDate
private Date entryDate
-
plateType
private PlateTypeData plateType
-
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
-
plateMapping
private PlateMappingData plateMapping
-
destinationIndex
private int destinationIndex
-
events
private Map<PlateEventTypeData,PlateEventData> events
-
wells
private Map<PlateCoordinate,WellData> wells
-
arrayDesigns
private Set<ArrayDesignPlateData> arrayDesigns
-
-
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)
-
getPlateType
public PlateTypeData getPlateType()
The plate type of this plate.- See Also:
PlateTypeData.getPlates()
- Hibernate: many-to-one
- column="`platetype_id`" not-null="true" outer-join="false" update="false"
-
setPlateType
public void setPlateType(PlateTypeData plateType)
-
getBarcode
public String getBarcode()
Get the barcode for the plate. 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.- Hibernate: property
- column="`destroyed`" type="boolean" not-null="true"
-
setDestroyed
public void setDestroyed(boolean destroyed)
-
getPlateMapping
public PlateMappingData getPlateMapping()
If this plate was created by a plate mapping, it is linked here. The source plates are kept in thegetParents()
property.- Hibernate: many-to-one
- column="`platemapping_id`" not-null="false" outer-join="false" update="false"
-
setPlateMapping
public void setPlateMapping(PlateMappingData plateMapping)
-
getDestinationIndex
public int getDestinationIndex()
If the plate was created by a plate mapping, this is the index of this plate in the list of created plates. First plate have index 0.- Hibernate: property
- column="`destination_index`" not-null="true" update="false"
-
setDestinationIndex
public void setDestinationIndex(int destinationIndex)
-
getParents
public Map<PlateData,Integer> getParents()
If the plate was created by aPlateMappingData
the source plates are kept here.- See Also:
getPlateMapping()
- Hibernate: map
- table="`PlateParents`" lazy="true"
- Hibernate: index-many-to-many
- column="`parent_id`" class="net.sf.basedb.core.data.PlateData"
- Hibernate: collection-key
- column="`plate_id`"
- Hibernate: collection-element
- column="`source_index`" type="int"
-
getParentSet
Set<PlateData> getParentSet()
Duplicate ofgetParents()
but with a set instead of a map. This is needed if we want to use the parent plates in a query.- Since:
- 2.9
- See Also:
getParents()
- Hibernate: set
- table="`PlateParents`" lazy="true" inverse="true"
- Hibernate: collection-key
- column="`plate_id`"
- Hibernate: collection-many-to-many
- column="`parent_id`" class="net.sf.basedb.core.data.PlateData"
-
getChildren
Set<PlateData> getChildren()
The childs plates created by plate mappings. This is the inverse end.- See Also:
getParents()
- Hibernate: set
- table="`PlateParents`" lazy="true" inverse="true"
- Hibernate: collection-key
- column="`parent_id`"
- Hibernate: collection-many-to-many
- column="`plate_id`" class="net.sf.basedb.core.data.PlateData"
-
getEvents
public Map<PlateEventTypeData,PlateEventData> getEvents()
The event for this plate. The event must have an event type that is valid for the corresponding plate type. This is the inverse end.- See Also:
PlateEventData.getPlate()
- Hibernate: map
- lazy="true" inverse="true" cascade="delete"
- Hibernate: index-many-to-many
- column="`plateeventtype_id`" class="net.sf.basedb.core.data.PlateEventTypeData"
- Hibernate: collection-key
- column="`plate_id`"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.PlateEventData"
-
setEvents
void setEvents(Map<PlateEventTypeData,PlateEventData> events)
-
getWells
public Map<PlateCoordinate,WellData> getWells()
The wells on this plate. This is the inverse end.- See Also:
WellData.getPlate()
- Hibernate: map
- lazy="true" inverse="true" cascade="all"
- Hibernate: collection-key
- column="`plate_id`"
- Hibernate: collection-composite-index
- class="net.sf.basedb.core.data.PlateCoordinate"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.WellData"
-
setWells
void setWells(Map<PlateCoordinate,WellData> wells)
-
getArrayDesigns
Set<ArrayDesignPlateData> getArrayDesigns()
Used by Hibernate to link with the arraydesign for this plate.- Hibernate: set
- lazy="true" inverse="true"
- Hibernate: collection-key
- column="`plate_id`"
- Hibernate: collection-one-to-many
- class="net.sf.basedb.core.data.ArrayDesignPlateData"
-
setArrayDesigns
void setArrayDesigns(Set<ArrayDesignPlateData> arrayDesigns)
-
-