Package com.inet.report.chart.axis

Class DateRange

java.lang.Object
com.inet.report.chart.axis.DateRange
All Implemented Interfaces:
Serializable
public class DateRange extends Object implements Serializable
Specifies a range of dates for i-net Clear Reports charts.
Since:
8.0
See Also:

  • Constructor Details

    • DateRange

      public DateRange()
      Creates a range controller for the date values. The default state of this range is automatic.
      Since:
      8.0

    • DateRange

      public DateRange(Date lower, Date upper)
      Sets a specific range, causing this range to no longer be an automatic range.
      Parameters:
      lower - the lower bound of range
      upper - the upper bound of range
      Throws:
      IllegalArgumentException - if lower or upper is null or if the upper value is lower than the lower value
      Since:
      8.0

  • Method Details

    • isAutoRange

      public boolean isAutoRange()
      Returns whether or not the range will be defined automatically, i.e. at run-time, and depending on the values in the chart.
      Returns:
      whether or not the range will be defined automatically, i.e. depending on the values in the chart.
      Since:
      8.0
      See Also:

    • setAutoRange

      public void setAutoRange(boolean autoRange)
      Sets whether or not the range is to be defined automatically, i.e. at run-time, and depending on the values in the chart.
      Parameters:
      autoRange - whether the range is to be defined automatically at run-time
      Since:
      8.0
      See Also:

    • getLowerBound

      public Date getLowerBound()
      Returns the manually set lower bound. Note that if this range is set to be defined automatically at run-time, that the lower bound could end up being a different one than the one returned here.
      Returns:
      the lower bound.
      Since:
      8.0
      See Also:

    • setLowerBound

      public void setLowerBound(Date lower)
      Manually sets the lower bound. Note that if this range is set to be defined automatically at run-time, that the lower bound could end up being a different one than the one being set here.
      Parameters:
      lower - the lower bound (null not permitted)
      Throws:
      IllegalArgumentException - if the parameter is greater than upper bound.
      Since:
      8.0
      See Also:

    • getLowerBoundFormula

      public FormulaField getLowerBoundFormula()
      Returns the manually set lower bound formula.
      Returns:
      the lower bound formula.
      Since:
      23.4

    • setLowerBoundFormula

      public void setLowerBoundFormula(FormulaField lowerBoundFormula)
      Manually sets the lower bound formula. Note that if this range is set to be defined automatically at run-time, that the lower bound could end up being a different one than the one being set here.
      Parameters:
      lowerBoundFormula - the lower bound formula (null not permitted)
      Since:
      23.4

    • getUpperBound

      public Date getUpperBound()
      Returns the upper bound. Note that if this range is set to be defined automatically at run-time, that the upper bound could end up being a different one than the one returned here.
      Returns:
      the upper bound.
      Since:
      8.0
      See Also:

    • setUpperBound

      public void setUpperBound(Date upper)
      Manually sets the upper bound. Note that if this range is set to be defined automatically at run-time, that the upper bound could end up being a different one than the one being set here.
      Parameters:
      upper - the upper bound (null not permitted)
      Throws:
      IllegalArgumentException - if the parameter is less than lower bound.
      Since:
      8.0
      See Also:

    • getUpperBoundFormula

      public FormulaField getUpperBoundFormula()
      Returns the manually set upper bound formula.
      Returns:
      the upper bound formula.
      Since:
      23.4

    • setUpperBoundFormula

      public void setUpperBoundFormula(FormulaField upperBoundFormula)
      Manually sets the upper bound formula. Note that if this range is set to be defined automatically at run-time, that the upper bound could end up being a different one than the one returned here.
      Parameters:
      upperBoundFormula - the upper bound formula (null not permitted)
      Since:
      23.4