Class BioWell

  • All Implemented Interfaces:
    AccessControlled, Identifiable

    public class BioWell
    extends ChildItem
    A biowell is located on a BioPlate and contains a MeasuredBioMaterial. The item holds information about witch row and column it is located on the bio plate.
    Version:
    2.10
    Author:
    Martin
    See Also:
    BioPlate
    Last modified
    $Date: 2008-11-27 16:33:55 +0100 (Thu, 27 Nov 2008) $
    • Method Detail

      • getQuery

        public static ItemQuery<BioWell> getQuery​(BioPlate bioPlate)
                                           throws InvalidDataException
        Get a query configured to retrieve wells for a plate. A plate is always required, but if a null bioplate parameter is used the query will include a parameter "bioPlate" that must be set before the query is actuall executed. The gain is that the same query can be re-used with multiple plates.
        Parameters:
        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 executed
        Returns:
        An ItemQuery object
        Throws:
        InvalidDataException
        See Also:
        Plate.getEvents()
      • getType

        public Item getType()
        Description copied from interface: Identifiable
        Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.
        Returns:
        A value indicating the type of item
      • getBioMaterialType

        public Item getBioMaterialType()
        Get the type of biomaterial that is placed in this well.
        Returns:
        The biomaterial type (SAMPLE or EXTRACT) or null if there is no biomaterial
        Since:
        3.2
      • getRow

        public int getRow()
        Gets the row index where this well is located.
        Returns:
        Row number as an int
      • getColumn

        public int getColumn()
        Gets the column index where this well is located.
        Returns:
        Column number as an int
      • getPlateCoordinate

        public PlateCoordinate getPlateCoordinate()
        Get the plate coordinate representation of the coordinate for this well.
        Returns:
        A PlateCoordinate object
        Since:
        2.17
      • getCoordinate

        public String getCoordinate()
        Get a string representation of the coordinate for this well. Rows are mapped to letters (0-A, 1-B, etc.). Columns are mapped to 1-based numbers (0-1, 1-2, etc.)
        Since:
        2.16
      • isEmpty

        public boolean isEmpty()
        Is this well empty?
        Since:
        2.16
      • getLockMode

        public BioWell.LockMode getLockMode()
        Get the lock mode of this well. The lock mode determines if it is possible to add biomaterial to an empty well or remove biomaterial from the well.
        Returns:
        The lock mode as determined by the plate's plate type
        Since:
        2.16
      • canAddBioMaterial

        public boolean canAddBioMaterial()
        Check if it is possible to add/change biomaterial in this well.
        Returns:
        TRUE if it is possible to add biomaterial to the well, FALSE otherwise
        Since:
        2.16
        See Also:
        BioWell.LockMode.canAdd(BioWell)
      • canClearBioMaterial

        public boolean canClearBioMaterial()
        Check if it is possible to clear the current biomaterial in this well.
        Returns:
        TRUE if it is possible to clear the well
        Since:
        2.16
        See Also:
        BioWell.LockMode.canClear(BioWell)
      • hasBeenUsed

        public boolean hasBeenUsed()
        If the original biomaterial in this well has been moved to another plate (eg. for final storage in a freezer). This property is only defined for well with lock mode=BioWell.LockMode.LOCKED_AFTER_MOVE.
        Returns:
        TRUE if the original biomaterial has been moved
        Since:
        2.16
      • getOriginalBioMaterial

        public MeasuredBioMaterial getOriginalBioMaterial()
        Get the original biomaterial that was placed in this biowell. This property is only defined for well with lock mode=BioWell.LockMode.LOCKED_AFTER_MOVE after the biomaterial has been moved.
        Returns:
        The original biomaterial
        Since:
        2.16