| java.lang.Object
 org.jfree.data.xy.IntervalXYDelegate
| IntervalXYDelegate | | public class IntervalXYDelegate implements DatasetChangeListener,DomainInfo,Serializable,Cloneable,PublicCloneable(Code) | | A delegate that handles the specification or automatic calculation of the
interval surrounding the x-values in a dataset. This is used to extend
a regular
XYDataset to support the
IntervalXYDataset
interface.
The decorator pattern was not used because of the several possibly
implemented interfaces of the decorated instance (e.g.
TableXYDataset ,
RangeInfo ,
DomainInfo etc.).
The width can be set manually or calculated automatically. The switch
autoWidth allows to determine which behavior is used. The auto width
calculation tries to find the smallest gap between two x-values in the
dataset. If there is only one item in the series, the auto width
calculation fails and falls back on the manually set interval width (which
is itself defaulted to 1.0).
|
| Method Summary | |
| public Object | clone()
| | public void | datasetChanged(DatasetChangeEvent e)
Handles events from the dataset by recalculating the interval if
necessary. | | public boolean | equals(Object obj)
Tests the delegate for equality with an arbitrary object.
Parameters:
obj - the object (null permitted). | | public Range | getDomainBounds(boolean includeInterval)
Returns the range of the values in the dataset's domain, including
or excluding the interval around each x-value as specified.
Parameters:
includeInterval - a flag that determines whether or not the x-interval should be taken into account. | | public double | getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
Parameters:
includeInterval - a flag that determines whether or not thex-interval is taken into account. | | public double | getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
Parameters:
includeInterval - a flag that determines whether or not thex-interval is taken into account. | | public Number | getEndX(int series, int item)
Returns the end value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. | | public double | getEndXValue(int series, int item)
Returns the end value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. | | public double | getFixedIntervalWidth()
Returns the fixed interval width. | | public double | getIntervalPositionFactor()
Returns the interval position factor. | | public double | getIntervalWidth()
Returns the interval width. | | public Number | getStartX(int series, int item)
Returns the start value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. | | public double | getStartXValue(int series, int item)
Returns the start value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. | | public boolean | isAutoWidth()
Returns true if the interval width is automatically
calculated, and false otherwise. | | public void | setAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically
calculated. | | public void | setFixedIntervalWidth(double w)
Sets the fixed interval width and, as a side effect, sets the
autoWidth flag to false. | | public void | setIntervalPositionFactor(double d)
Sets the interval position factor. |
| IntervalXYDelegate | | public IntervalXYDelegate(XYDataset dataset)(Code) | | Creates a new delegate that.
Parameters:
dataset - the underlying dataset (null not permitted). |
| IntervalXYDelegate | | public IntervalXYDelegate(XYDataset dataset, boolean autoWidth)(Code) | | Creates a new delegate for the specified dataset.
Parameters:
dataset - the underlying dataset (null not permitted).
Parameters:
autoWidth - a flag that controls whether the interval width is calculated automatically. |
| datasetChanged | | public void datasetChanged(DatasetChangeEvent e)(Code) | | Handles events from the dataset by recalculating the interval if
necessary.
Parameters:
e - the event. |
| equals | | public boolean equals(Object obj)(Code) | | Tests the delegate for equality with an arbitrary object.
Parameters:
obj - the object (null permitted). A boolean. |
| getDomainBounds | | public Range getDomainBounds(boolean includeInterval)(Code) | | Returns the range of the values in the dataset's domain, including
or excluding the interval around each x-value as specified.
Parameters:
includeInterval - a flag that determines whether or not the x-interval should be taken into account. The range. |
| getDomainLowerBound | | public double getDomainLowerBound(boolean includeInterval)(Code) | | Returns the minimum x-value in the dataset.
Parameters:
includeInterval - a flag that determines whether or not thex-interval is taken into account. The minimum value. |
| getDomainUpperBound | | public double getDomainUpperBound(boolean includeInterval)(Code) | | Returns the maximum x-value in the dataset.
Parameters:
includeInterval - a flag that determines whether or not thex-interval is taken into account. The maximum value. |
| getEndX | | public Number getEndX(int series, int item)(Code) | | Returns the end value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. The end value of the x-interval (possibly null).
See Also: IntervalXYDelegate.getEndXValue(int,int) |
| getEndXValue | | public double getEndXValue(int series, int item)(Code) | | Returns the end value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. The end value of the x-interval.
See Also: IntervalXYDelegate.getEndX(int,int) |
| getFixedIntervalWidth | | public double getFixedIntervalWidth()(Code) | | Returns the fixed interval width.
The fixed interval width. |
| getIntervalPositionFactor | | public double getIntervalPositionFactor()(Code) | | Returns the interval position factor.
The interval position factor. |
| getIntervalWidth | | public double getIntervalWidth()(Code) | | Returns the interval width. This method will return either the
auto calculated interval width or the manually specified interval
width, depending on the
IntervalXYDelegate.isAutoWidth() result.
The interval width to use. |
| getStartX | | public Number getStartX(int series, int item)(Code) | | Returns the start value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. The start value of the x-interval (possibly null).
See Also: IntervalXYDelegate.getStartXValue(int,int) |
| getStartXValue | | public double getStartXValue(int series, int item)(Code) | | Returns the start value of the x-interval for an item within a series.
Parameters:
series - the series index.
Parameters:
item - the item index. The start value of the x-interval.
See Also: IntervalXYDelegate.getStartX(int,int) |
| isAutoWidth | | public boolean isAutoWidth()(Code) | | Returns true if the interval width is automatically
calculated, and false otherwise.
A boolean. |
| setAutoWidth | | public void setAutoWidth(boolean b)(Code) | | Sets the flag that indicates whether the interval width is automatically
calculated. If the flag is set to true, the interval is
recalculated.
Note: recalculating the interval amounts to changing the data values
represented by the dataset. The calling dataset must fire an
appropriate
DatasetChangeEvent .
Parameters:
b - a boolean. |
| setFixedIntervalWidth | | public void setFixedIntervalWidth(double w)(Code) | | Sets the fixed interval width and, as a side effect, sets the
autoWidth flag to false.
Note that changing the interval width amounts to changing the data
values represented by the dataset. Therefore, the dataset
that is using this delegate is responsible for generating the
appropriate
DatasetChangeEvent .
Parameters:
w - the width (negative values not permitted). |
| setIntervalPositionFactor | | public void setIntervalPositionFactor(double d)(Code) | | Sets the interval position factor. This controls how the interval is
aligned to the x-value. For a value of 0.5, the interval is aligned
with the x-value in the center. For a value of 0.0, the interval is
aligned with the x-value at the lower end of the interval, and for a
value of 1.0, the interval is aligned with the x-value at the upper
end of the interval.
Note that changing the interval position factor amounts to changing the
data values represented by the dataset. Therefore, the dataset that is
using this delegate is responsible for generating the
appropriate
DatasetChangeEvent .
Parameters:
d - the new interval position factor (in the range 0.0 to 1.0 inclusive). |
|
|