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

Class Dimension

java.lang.Object
com.genologics.ri.containertype.Dimension
All Implemented Interfaces:
Serializable
public class Dimension extends Object implements Serializable
Dimension is a child element of container type and describes the size and identification method of the horizontal and vertical dimensions of the coordinate system of the container type.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Boolean
    alpha
    Whether numbering in this dimension is using letters (true) or numbers (false).
    protected Integer
    offset
    The offset applied to the first element in this dimension.
    protected Integer
    size
    The size (number of elements) in this dimension.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Dimension()
    Default constructor for creating a new dimension.
    Dimension(Integer size)
    Constructor for creating a dimension with a specified size.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getOffset()
    Gets the offset applied to the first element in this dimension.
    Integer
    getSize()
    Gets the size (number of elements) in this dimension.
    Boolean
    isAlpha()
    Checks if numbering in this dimension is alphabetic.
    void
    setAlpha(Boolean alpha)
    Sets whether numbering in this dimension is alphabetic.
    void
    setOffset(Integer offset)
    Sets the offset applied to the first element in this dimension.
    void
    setSize(Integer size)
    Sets the size (number of elements) in this dimension.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • alpha

      protected Boolean alpha
      Whether numbering in this dimension is using letters (true) or numbers (false).

    • offset

      protected Integer offset
      The offset applied to the first element in this dimension. For example, an offset of 1 means the first element is numbered/lettered as 1 or B instead of 0 or A.

    • size

      protected Integer size
      The size (number of elements) in this dimension.

  • Constructor Details

    • Dimension

      public Dimension()
      Default constructor for creating a new dimension.

    • Dimension

      public Dimension(Integer size)
      Constructor for creating a dimension with a specified size.
      Parameters:
      size - The size (number of elements) in this dimension.

  • Method Details

    • isAlpha

      public Boolean isAlpha()
      Checks if numbering in this dimension is alphabetic.
      Returns:
      true if using letters (A, B, C...), false if using numbers (0, 1, 2...).

    • setAlpha

      public void setAlpha(Boolean alpha)
      Sets whether numbering in this dimension is alphabetic.
      Parameters:
      alpha - true if using letters (A, B, C...), false if using numbers (0, 1, 2...).

    • getOffset

      public Integer getOffset()
      Gets the offset applied to the first element in this dimension.
      Returns:
      The offset value.

    • setOffset

      public void setOffset(Integer offset)
      Sets the offset applied to the first element in this dimension.
      Parameters:
      offset - The offset value to set.

    • getSize

      public Integer getSize()
      Gets the size (number of elements) in this dimension.
      Returns:
      The size of this dimension.

    • setSize

      public void setSize(Integer size)
      Sets the size (number of elements) in this dimension.
      Parameters:
      size - The size to set.