com.inet.report.chart.axis

Class DateRange

java.lang.Object

com.inet.report.chart.axis.DateRange

All Implemented Interfaces:

java.io.Serializable

public class DateRange
extends java.lang.Object
implements java.io.Serializable

Specifies a range of dates for i-net Clear Reports charts.

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateRange() Creates a range controller for the date values.
DateRange(java.util.Date lower, java.util.Date upper) Sets a specific range, causing this range to no longer be an automatic range.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getLowerBound() Returns the manually set lower bound.
java.util.Date	getUpperBound() Returns the upper bound.
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.
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.
void	setLowerBound(java.util.Date lower) Manually sets the lower bound.
void	setUpperBound(java.util.Date upper) Manually sets the upper bound.

Constructor Detail

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(java.util.Date lower,
                 java.util.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:

java.lang.IllegalArgumentException - if lower or upper is null or if the upper value is lower than the lower value

Since:

8.0

Method Detail

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(boolean)

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:

isAutoRange()

getLowerBound

public java.util.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(Date)

setLowerBound

public void setLowerBound(java.util.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:

java.lang.IllegalArgumentException - if the parameter is greater than upper bound.

Since:

8.0

See Also:

getLowerBound()

getUpperBound

public java.util.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(Date)

setUpperBound

public void setUpperBound(java.util.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:

java.lang.IllegalArgumentException - if the parameter is less than lower bound.

Since:

8.0

See Also:

getUpperBound()