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 Summary

    Fields
    Modifier and Type
    Field
    Description
    protected List<CalibrantWell>
    calibrantWells
    Deprecated.
    This property is no longer supported and will be ignored if provided.
    protected Dimension
    columns
    The x-dimension (horizontal/columns) of the container's coordinate system.
    protected String
    name
    The name of the container type.
    protected Dimension
    rows
    The y-dimension (vertical/rows) of the container's coordinate system.
    protected Boolean
    tube
    Indicates whether this container type represents a tube (single well) or a multi-well container.
    protected List<String>
    unavailableWells
    List of well locations that are not available for storing samples or reagents.
    protected URI
    uri
    The URI for accessing this container type resource.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContainerType()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<CalibrantWell>
    getCalibrantWells()
    Deprecated.
    This property is no longer supported and will be ignored if provided.
    Integer
    getCapacity()
    Get the capacity of a container of this type, i.e. the columns * rows.
    Dimension
    getColumns()
    Gets the x-dimension (horizontal/columns) of the container's coordinate system.
    LimsLink<ContainerType>
    getLink()
    Get a concrete link object to this Linkable thing.
    String
    getName()
    Gets the name of the container type.
    Dimension
    getRows()
    Gets the y-dimension (vertical/rows) of the container's coordinate system.
    List<String>
    getUnavailableWells()
    Gets the list of unavailable wells for this container type.
    URI
    getUri()
    Gets the URI for accessing this container type resource.
    Boolean
    isTube()
    Checks if this container type represents a tube (single well container).
    void
    setColumns(Dimension columns)
    Sets the x-dimension (horizontal/columns) of the container's coordinate system.
    void
    setName(String name)
    Sets the name of the container type.
    void
    setRows(Dimension rows)
    Sets the y-dimension (vertical/rows) of the container's coordinate system.
    void
    setTube(Boolean tube)
    Sets whether this container type represents a tube.
    void
    setUri(URI uri)
    Sets the URI for this container type.
    String
    toString()
    Returns a string representation of this container type, which is its name.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • tube

      protected Boolean tube
      Indicates whether this container type represents a tube (single well) or a multi-well container.

    • calibrantWells

      @Deprecated protected List<CalibrantWell> calibrantWells
      Deprecated.
      This property is no longer supported and will be ignored if provided.
      List of calibrant wells that are reserved for calibrants in containers of this type.

    • unavailableWells

      protected List<String> unavailableWells
      List of well locations that are not available for storing samples or reagents. Well locations are specified using the coordinate system defined by the x-dimension and y-dimension.

    • columns

      protected Dimension columns
      The x-dimension (horizontal/columns) of the container's coordinate system.

    • rows

      protected Dimension rows
      The y-dimension (vertical/rows) of the container's coordinate system.

    • name

      protected String name
      The name of the container type.

    • uri

      protected URI uri
      The URI for accessing this container type resource.

  • Constructor Details

    • ContainerType

      public ContainerType()

  • Method Details

    • isTube

      public Boolean isTube()
      Checks if this container type represents a tube (single well container).
      Returns:
      true if this is a tube, false if it is a multi-well container.

    • setTube

      public void setTube(Boolean tube)
      Sets whether this container type represents a tube.
      Parameters:
      tube - true if this is a tube, false if it is a multi-well container.

    • 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()
      Gets the list of unavailable wells for this container type.

      Unavailable wells are locations that are not available for storing samples or reagents, either because they must remain empty for instrument configuration or contain specific calibrants required by the instrument. Well locations are specified using the coordinate system defined by the x-dimension and y-dimension.

      Returns:
      The list of unavailable well locations. Never null.

    • getName

      public String getName()
      Gets the name of the container type.
      Returns:
      The container type name.

    • setName

      public void setName(String name)
      Sets the name of the container type.
      Parameters:
      name - The container type name to set.

    • getUri

      public URI getUri()
      Gets the URI for accessing this container type resource.
      Specified by:
      getUri in interface Locatable
      Returns:
      The container type URI.

    • setUri

      public void setUri(URI uri)
      Sets the URI for this container type.
      Specified by:
      setUri in interface Locatable
      Parameters:
      uri - The container type URI to set.

    • getColumns

      public Dimension getColumns()
      Gets the x-dimension (horizontal/columns) of the container's coordinate system.
      Returns:
      The column dimension specification.

    • setColumns

      public void setColumns(Dimension columns)
      Sets the x-dimension (horizontal/columns) of the container's coordinate system.
      Parameters:
      columns - The column dimension specification to set.

    • getRows

      public Dimension getRows()
      Gets the y-dimension (vertical/rows) of the container's coordinate system.
      Returns:
      The row dimension specification.

    • setRows

      public void setRows(Dimension rows)
      Sets the y-dimension (vertical/rows) of the container's coordinate system.
      Parameters:
      rows - The row dimension specification to set.

    • 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()
      Returns a string representation of this container type, which is its name.
      Overrides:
      toString in class Object
      Returns:
      The container type name.

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