Record Class CyBoundingBox

java.lang.Object
java.lang.Record
org.cy3sbml.layout.CyBoundingBox
Record Components:
cyId - cyId of the node, null in old layout files
sbmlId - SBML id of the node, null for nodes of elements without id
glyph - glyph of the node of a layout network, null for all other nodes

public record CyBoundingBox(String cyId, String sbmlId, String glyph, double x, double y, double height, double width) extends Record
Position and size of a node in a layout file.

The node is identified by its cyId, the unique id of the SBML element of the node (column cyId), which every node of an imported SBML network has. The SBML id (column sbml id) is only set for nodes of elements with an id; layout files written before the cyId was stored identify the nodes by it alone. In a layout network the glyphs of one element (aliases) have the same cyId, so their nodes are identified by the glyph (column layout_glyph).

  • Constructor Summary

    Constructors
    Constructor
    Description
    CyBoundingBox(String cyId, String sbmlId, String glyph, double x, double y, double height, double width)
    Creates an instance of a CyBoundingBox record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the cyId record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    Returns the value of the glyph record component.
    final int
    Returns a hash code value for this object.
    double
    Returns the value of the height record component.
    Returns the value of the sbmlId record component.
    final String
    Returns a string representation of this record class.
    double
    Returns the value of the width record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • CyBoundingBox

      public CyBoundingBox(String cyId, String sbmlId, String glyph, double x, double y, double height, double width)
      Creates an instance of a CyBoundingBox record class.
      Parameters:
      cyId - the value for the cyId record component
      sbmlId - the value for the sbmlId record component
      glyph - the value for the glyph record component
      x - the value for the x record component
      y - the value for the y record component
      height - the value for the height record component
      width - the value for the width record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • cyId

      public String cyId()
      Returns the value of the cyId record component.
      Returns:
      the value of the cyId record component
    • sbmlId

      public String sbmlId()
      Returns the value of the sbmlId record component.
      Returns:
      the value of the sbmlId record component
    • glyph

      public String glyph()
      Returns the value of the glyph record component.
      Returns:
      the value of the glyph record component
    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component
    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component
    • height

      public double height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component
    • width

      public double width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component