Package org.cip4.jdflib.datatypes

Class JDFRectangleRange

java.lang.Object
org.cip4.jdflib.datatypes.JDFRange
org.cip4.jdflib.datatypes.JDFRectangleRange
All Implemented Interfaces:
JDFBaseDataTypes
public class JDFRectangleRange extends JDFRange

  • Constructor Details

    • JDFRectangleRange

      public JDFRectangleRange()
      constructs a xy pair range with all values set to 0.0 Double

    • JDFRectangleRange

      public JDFRectangleRange(JDFRectangle x)
      constructs a JDFRectangleRange, both values are equal ("from x to x")
      Parameters:
      x - - the given JDFRectangle

    • JDFRectangleRange

      public JDFRectangleRange(JDFRectangle xmin, JDFRectangle xmax)
      constructor a JDFRectangleRange with two JDFRectangle values/bounds ("from xmin to xmax")
      Parameters:
      xmin - the given min value
      xmax - the given max value

    • JDFRectangleRange

      public JDFRectangleRange(JDFRectangleRange r)
      copy constructor - constructs a JDFRectangleRange with the given JDFRectangleRange
      Parameters:
      r - the JDFRectangleRange to copy

    • JDFRectangleRange

      public JDFRectangleRange(String s) throws DataFormatException
      Constructs a JDFRectangleRange with the values of the given string
      Parameters:
      s - the given string representation of the range
      Throws:
      DataFormatException - - if the String has not a valid format

  • Method Details

    • init

      protected void init(JDFRectangle x, JDFRectangle y)
      Initialization
      Parameters:
      x - left value
      y - right value

    • isValid

      public boolean isValid(String s)
      isValid - validate the given String
      Parameters:
      s - the given string
      Returns:
      boolean - false if the String has not a valid format

    • equals

      public boolean equals(Object other)
      equals - returns true if both JDFRectangleRanges are equal otherwise false
      Overrides:
      equals in class JDFRange
      Parameters:
      other - the JDFRectangleRange to compare
      Returns:
      boolean - true if equal, otherwise false

    • hashCode

      public int hashCode()
      hashCode complements equals() to fulfill the equals/hashCode contract
      Overrides:
      hashCode in class JDFRange
      Returns:
      int

    • inRange

      public boolean inRange(JDFRectangle x)
      inRange - tests if the given x inside of this range
      Parameters:
      x - comparison value
      Returns:
      boolean - true if x in range

    • isPartOfRange

      public boolean isPartOfRange(JDFRange ra)
      isPartOfRange - is range 'r' within this range?
      Specified by:
      isPartOfRange in class JDFRange
      Parameters:
      ra - the range to test
      Returns:
      boolean - true if range 'r' is within this range, else false

    • getLeft

      public JDFRectangle getLeft()
      getLeft - gets the left JDFRectangle object of the range
      Returns:
      JDFRectangle - the left JDFRectangle object of the range

    • getRight

      public JDFRectangle getRight()
      getRight - gets the right JDFRectangle object of the range
      Returns:
      JDFRectangle - the right JDFRectangle object of the range

    • setLeft

      public void setLeft(JDFRectangle x)
      sets the left JDFRectangle object of the range
      Parameters:
      x - the left JDFRectangle object of the range

    • setRight

      public void setRight(JDFRectangle x)
      sets the right JDFRectangle object of the range
      Parameters:
      JDFRectangle - x - the right JDFRectangle object of the range

    • getUpperValue

      public JDFRectangle getUpperValue()
      getUpperValue - returns the upper value of the bounds
      Returns:
      JDFRectangle - the upper value of the range

    • getLowerValue

      public JDFRectangle getLowerValue()
      getLowerValue - returns the lower value of the bounds
      Returns:
      JDFRectangle - the lower value of the range

    • getRightObject

      protected Object getRightObject()
      Specified by:
      getRightObject in class JDFRange

    • getLeftObject

      protected Object getLeftObject()
      Specified by:
      getLeftObject in class JDFRange

    • inObjectRange

      protected boolean inObjectRange(Object other)
      Overrides:
      inObjectRange in class JDFRange