public class BioWell extends ChildItem<BioWellData>
BioPlate
and contains a MeasuredBioMaterial
.
The item holds information about witch row and column it is located on the bio plate.BioPlate
Modifier and Type | Class and Description |
---|---|
static class |
BioWell.LockMode
The lock mode for a well is determined by the plate's bio
plate type.
|
Modifier and Type | Field and Description |
---|---|
static Item |
TYPE
The type of item represented by this class.
|
Constructor and Description |
---|
BioWell(BioWellData data) |
Modifier and Type | Method and Description |
---|---|
boolean |
canAddBioMaterial()
Check if it is possible to add/change biomaterial in this well.
|
boolean |
canClearBioMaterial()
Check if it is possible to clear the current biomaterial in this well.
|
MeasuredBioMaterial |
getBioMaterial()
Gets the
MeasuredBioMaterial connected to this biowell. |
Item |
getBioMaterialType()
Get the type of biomaterial that is placed in this well.
|
static BioWell |
getById(DbControl dc,
int id)
Get a
BioWell item when you know the id. |
int |
getColumn()
Gets the column index where this well is located.
|
java.lang.String |
getCoordinate()
Get a string representation of the coordinate for this well.
|
BioWell.LockMode |
getLockMode()
Get the lock mode of this well.
|
MeasuredBioMaterial |
getOriginalBioMaterial()
Get the original biomaterial that was placed in this biowell.
|
BioPlate |
getPlate()
Get the
BioPlate this biowell belongs to. |
PlateCoordinate |
getPlateCoordinate()
Get the plate coordinate representation of the coordinate for this well.
|
static ItemQuery<BioWell> |
getQuery(BioPlate bioPlate)
Get a query configured to retrieve wells for a plate.
|
int |
getRow()
Gets the row index where this well is located.
|
(package private) SharedData |
getSharedParent()
Get the shareable parent item of this child item.
|
Item |
getType()
Get the type of item represented by the object.
|
java.util.Set<ItemProxy> |
getUsingItems()
Adds the
MeasuredBioMaterial ,used in this well, to the Set. |
boolean |
hasBeenUsed()
If the original biomaterial in this well has been moved to
another plate (eg. for final storage in a freezer).
|
boolean |
isEmpty()
Is this well empty?
|
boolean |
isUsed()
Check if a
MeasuredBioMaterial is linked to this bio-well |
getPermissionForUse, getPermissionForWriteDeleteAndCreate, getPluginPermissions, initPermissions
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate
public static final Item TYPE
Item.BIOWELL
,
getType()
BioWell(BioWellData data)
public static BioWell getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
BioWell
item when you know the id.dc
- The DbControl
which will be used for
permission checking and database access.id
- The id of the item to loadBioWell
itemItemNotFoundException
- If an item with the specified
id is not foundPermissionDeniedException
- If the logged in user doesn't
have Permission.READ
permission to the itemBaseException
- If there is another errorpublic static ItemQuery<BioWell> getQuery(BioPlate bioPlate) throws InvalidDataException
bioPlate
- The plate to retreive wells for, null is allowed
but a bioplate must be set for the "bioPlate" query parameter
before the query is executedItemQuery
objectInvalidDataException
Plate.getEvents()
public Item getType()
Identifiable
Item
enumeration.public java.util.Set<ItemProxy> getUsingItems()
MeasuredBioMaterial
,used in this well, to the Set.getUsingItems
in class BasicItem<BioWellData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public boolean isUsed() throws BaseException
MeasuredBioMaterial
is linked to this bio-wellisUsed
in class BasicItem<BioWellData>
BaseException
- If not able to tell if item is used or not.BasicItem.getUsingItems()
SharedData getSharedParent()
ChildItem
ChildItem.initPermissions(int, int)
method to calculate
the logged in user's permissions for the child item.getSharedParent
in class ChildItem<BioWellData>
public BioPlate getPlate() throws PermissionDeniedException, BaseException
BioPlate
this biowell belongs to.BioPlate
itemPermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission for the bioplateBaseException
- If there is another errorpublic MeasuredBioMaterial getBioMaterial() throws PermissionDeniedException, BaseException
MeasuredBioMaterial
connected to this biowell.MeasuredBioMaterial
item or null.PermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission for the biomaterial.BaseException
- If there is another errorpublic Item getBioMaterialType()
public int getRow()
int
public int getColumn()
int
public PlateCoordinate getPlateCoordinate()
public java.lang.String getCoordinate()
public boolean isEmpty()
public BioWell.LockMode getLockMode()
public boolean canAddBioMaterial()
BioWell.LockMode.canAdd(BioWell)
public boolean canClearBioMaterial()
BioWell.LockMode.canClear(BioWell)
public boolean hasBeenUsed()
BioWell.LockMode.LOCKED_AFTER_MOVE
.public MeasuredBioMaterial getOriginalBioMaterial()
BioWell.LockMode.LOCKED_AFTER_MOVE
after the biomaterial has been moved.