Module com.genologics.ri
Package com.genologics.ri.container

Class Container

java.lang.Object
com.genologics.ri.container.Container
All Implemented Interfaces:
LimsEntity<Container>, LimsEntityLinkable<Container>, Linkable<Container>, Locatable, UDFHolder, Serializable
public class Container extends Object implements LimsEntity<Container>, UDFHolder, Serializable
Container entity representing a physical container in the Clarity LIMS.
See Also:

  • Field Details

    • name

      protected String name
      The name of the container.

    • containerType

      protected ContainerTypeLink containerType
      Link to the container type.

    • occupiedWells

      protected Long occupiedWells
      The number of occupied wells in the container.

    • placements

      protected List<Placement> placements
      The list of placements in the container.

    • type

      protected UDT type
      The user-defined type for the container.

    • fields

      protected List<UDF> fields
      The list of user-defined fields for the container.

    • state

      protected ContainerState state
      Container state. Note this has changed from a string to an enum from release 2.31.6.

    • limsid

      protected String limsid
      The LIMS id of the container.

    • uri

      protected URI uri
      The URI of the container.

  • Constructor Details

    • Container

      public Container()
      Default constructor.

    • Container

      public Container(URI uri)
      Constructor for Container with a URI.
      Parameters:
      uri - The URI of the container.

    • Container

      public Container(URI uri, String limsid)
      Constructor for Container with a URI and LIMS id.
      Parameters:
      uri - The URI of the container.
      limsid - The LIMS id of the container.

    • Container

      public Container(Linkable<ContainerType> containerType)
      Constructor with container type link.
      Parameters:
      containerType - the container type link.

    • Container

      public Container(Linkable<ContainerType> containerType, String name)
      Constructor with container type link and name.
      Parameters:
      containerType - the container type link.
      name - the name of the container.

    • Container

      public Container(ContainerType containerType)
      Constructor with container type.
      Parameters:
      containerType - the container type.

    • Container

      public Container(ContainerType containerType, String name)
      Constructor with container type and name.
      Parameters:
      containerType - the container type.
      name - the name of the container.

  • Method Details

    • getLimsid

      public String getLimsid()
      Gets the LIMS id.
      Specified by:
      getLimsid in interface LimsEntityLinkable<Container>
      Returns:
      the LIMS id.

    • setLimsid

      public void setLimsid(String value)
      Sets the LIMS id.
      Specified by:
      setLimsid in interface LimsEntityLinkable<Container>
      Parameters:
      value - the LIMS id.

    • getUri

      public URI getUri()
      Gets the URI.
      Specified by:
      getUri in interface Locatable
      Returns:
      the URI.

    • setUri

      public void setUri(URI value)
      Sets the URI.
      Specified by:
      setUri in interface Locatable
      Parameters:
      value - the URI.

    • getName

      public String getName()
      Gets the name.
      Returns:
      the name.

    • setName

      public void setName(String name)
      Sets the name.
      Parameters:
      name - the name.

    • getContainerType

      public ContainerTypeLink getContainerType()
      Gets the container type link.
      Returns:
      the container type link.

    • setContainerType

      public void setContainerType(Linkable<ContainerType> link)
      Sets the container type from a linkable.
      Parameters:
      link - the linkable container type.

    • setContainerType

      public void setContainerType(ContainerType containerType)
      Sets the container type.
      Parameters:
      containerType - the container type.

    • getOccupiedWells

      public Long getOccupiedWells()
      Gets the number of occupied wells.
      Returns:
      the number of occupied wells.

    • setOccupiedWells

      public void setOccupiedWells(Long occupiedWells)
      Sets the number of occupied wells.
      Parameters:
      occupiedWells - the number of occupied wells.

    • getPlacements

      public List<Placement> getPlacements()
      Gets the list of placements.
      Returns:
      the list of placements.

    • setPlacements

      public void setPlacements(Collection<? extends LimsEntityLinkable<Artifact>> links)
      Sets the placements from a collection of artifact links.
      Parameters:
      links - the collection of artifact links.

    • addPlacement

      public Placement addPlacement(Placement p)
      Adds a placement to the container.
      Parameters:
      p - the placement to add.
      Returns:
      the added placement.

    • addPlacement

      public Placement addPlacement(LimsEntityLinkable<Artifact> artifact, String wellPosition)
      Adds a placement to the container with an artifact and well position.
      Parameters:
      artifact - the artifact to place.
      wellPosition - the well position.
      Returns:
      the added placement.

    • getUserDefinedType

      public UDT getUserDefinedType()
      Gets the user-defined type.
      Returns:
      the user-defined type.

    • setUserDefinedType

      public UDT setUserDefinedType(UDT type)
      Sets the user-defined type.
      Parameters:
      type - the user-defined type.
      Returns:
      the user-defined type.

    • setUserDefinedType

      public UDT setUserDefinedType(String type)
      Sets the user-defined type from a string.
      Parameters:
      type - the type name.
      Returns:
      the user-defined type.

    • getUserDefinedFields

      public List<UDF> getUserDefinedFields()
      Gets the list of user-defined fields.
      Specified by:
      getUserDefinedFields in interface UDFHolder
      Returns:
      the list of user-defined fields.

    • getState

      public ContainerState getState()
      Gets the container state.
      Returns:
      the container state.

    • setState

      public void setState(ContainerState state)
      Sets the container state.
      Parameters:
      state - the container state.

    • toString

      public String toString()
      Returns a string representation of the container.
      Overrides:
      toString in class Object
      Returns:
      a string representation.

    • getLink

      public LimsEntityLink<Container> getLink()
      Gets a link to this container.
      Specified by:
      getLink in interface LimsEntityLinkable<Container>
      Specified by:
      getLink in interface Linkable<Container>
      Returns:
      a link to this container.