Module com.genologics.ri
Package com.genologics.ri.containertype

Class ContainerType

java.lang.Object
com.genologics.ri.containertype.ContainerType
All Implemented Interfaces:
Linkable<ContainerType>, Locatable, Serializable
public class ContainerType extends Object implements Linkable<ContainerType>, Serializable
The detailed representation of a container type.

The container type describes the physical characteristics of a class of containers such as the number of wells in the container as well as describing the coordinate system used for identifying those wells.

The container type is described using a rectangular coordinate system. The characteristics of the horizontal axis are described by the x-dimension element, and the characteristics of the vertical dimension are described by the y-dimension child elements. The characteristics of each dimension included both the size in that dimension as well as the identification method for values in that dimension. Values can be identified either numerically where 0 is the first item or alphabetically where A is the first element. Additionally an offset can be specified which shifts the value of the first element by a fixed amount. When a well location is represented using the coordinate system, it is shown as Y-Value:X-Value (for example A:1).

The following are examples of the coordinate system:

  • Y-Dimension: alphabetic, size 1, offset 0. X-Dimension: numeric, size 1, offset 0. Size: 1. Valid value: A:0
  • Y-Dimension: alphabetic, size 12, offset 0. X-Dimension: numeric, size 8, offset 0. Size: 96. Valid values: A:0 ... L:7
  • Y-Dimension: alphabetic, size 8, offset 0. X-Dimension: numeric, size 12, offset 1. Size: 96. Valid values: A:1 ... H:12

The container type also identifies wells in the container that are not available for storing samples or reagents, either because the configuration of the container requires those wells to be empty for the instrument configuration or because the well contains specific calibrants that are required by the instrument. The well location of the unavailable wells is specified using the coordinate system that is described by the x-dimension and y-dimension of the container type.

Note: calibrant-well is no longer supported and will be ignored if provided.

See Also:

  • Field Details

  • Constructor Details

    • ContainerType

      public ContainerType()

  • Method Details

    • isTube

      public Boolean isTube()

    • setTube

      public void setTube(Boolean tube)

    • getCalibrantWells

      @Deprecated public List<CalibrantWell> getCalibrantWells()
      Deprecated.
      This property is no longer supported and will be ignored if provided.
      Each calibrant well identifies a well location that is reserved for calibrants in containers of the container type.
      Returns:
      A list of calibrant wells.

    • getUnavailableWells

      public List<String> getUnavailableWells()

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getUri

      public URI getUri()
      Description copied from interface: Locatable
      Get the URI of this object.
      Specified by:
      getUri in interface Locatable
      Returns:
      The URI.

    • setUri

      public void setUri(URI uri)
      Description copied from interface: Locatable
      Set the URI of this object.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - The new URI.

    • getColumns

      public Dimension getColumns()

    • setColumns

      public void setColumns(Dimension columns)

    • getRows

      public Dimension getRows()

    • setRows

      public void setRows(Dimension rows)

    • getCapacity

      public Integer getCapacity()
      Get the capacity of a container of this type, i.e. the columns * rows.
      Returns:
      The capacity (number of lanes/wells). If this cannot be calculated through missing values, returns null.
      Since:
      2.31.2

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getLink

      public LimsLink<ContainerType> getLink()
      Get a concrete link object to this Linkable thing.
      Specified by:
      getLink in interface Linkable<ContainerType>
      Returns:
      A LimsLink to this object.