public class

IntervalXYDelegate

extends Object
implements Serializable Cloneable DomainInfo DatasetChangeListener
java.lang.Object
   ↳ org.jfree.data.xy.IntervalXYDelegate

Class Overview

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).

Summary

Public Constructors
IntervalXYDelegate(XYDataset dataset)
Creates a new delegate that.
IntervalXYDelegate(XYDataset dataset, boolean autoWidth)
Creates a new delegate for the specified dataset.
Public Methods
Object clone()
void datasetChanged(DatasetChangeEvent e)
Handles events from the dataset by recalculating the interval if necessary.
boolean equals(Object obj)
Tests the delegate for equality with an arbitrary object.
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.
double getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
double getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
Number getEndX(int series, int item)
Returns the end value of the x-interval for an item within a series.
double getEndXValue(int series, int item)
Returns the end value of the x-interval for an item within a series.
double getFixedIntervalWidth()
Returns the fixed interval width.
double getIntervalPositionFactor()
Returns the interval position factor.
double getIntervalWidth()
Returns the interval width.
Number getStartX(int series, int item)
Returns the start value of the x-interval for an item within a series.
double getStartXValue(int series, int item)
Returns the start value of the x-interval for an item within a series.
int hashCode()
Returns a hash code for this instance.
boolean isAutoWidth()
Returns true if the interval width is automatically calculated, and false otherwise.
void setAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically calculated.
void setFixedIntervalWidth(double w)
Sets the fixed interval width and, as a side effect, sets the autoWidth flag to false.
void setIntervalPositionFactor(double d)
Sets the interval position factor.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.data.DomainInfo
From interface org.jfree.data.general.DatasetChangeListener

Public Constructors

public IntervalXYDelegate (XYDataset dataset)

Creates a new delegate that.

Parameters
dataset the underlying dataset (null not permitted).

public IntervalXYDelegate (XYDataset dataset, boolean autoWidth)

Creates a new delegate for the specified dataset.

Parameters
dataset the underlying dataset (null not permitted).
autoWidth a flag that controls whether the interval width is calculated automatically.

Public Methods

public Object clone ()

Returns
  • A clone of this delegate.
Throws
CloneNotSupportedException if the object cannot be cloned.

public void datasetChanged (DatasetChangeEvent e)

Handles events from the dataset by recalculating the interval if necessary.

Parameters
e the event.

public boolean equals (Object obj)

Tests the delegate for equality with an arbitrary object. The equality test considers two delegates to be equal if they would calculate the same intervals for any given dataset (for this reason, the dataset itself is NOT included in the equality test, because it is just a reference back to the current 'owner' of the delegate).

Parameters
obj the object (null permitted).
Returns
  • A boolean.

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.
Returns
  • The range.

public double getDomainLowerBound (boolean includeInterval)

Returns the minimum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The minimum value.

public double getDomainUpperBound (boolean includeInterval)

Returns the maximum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The maximum value.

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.
item the item index.
Returns
  • The end value of the x-interval (possibly null).
See Also

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.
item the item index.
Returns
  • The end value of the x-interval.
See Also

public double getFixedIntervalWidth ()

Returns the fixed interval width.

Returns
  • The fixed interval width.

public double getIntervalPositionFactor ()

Returns the interval position factor.

Returns
  • The interval position factor.

public double getIntervalWidth ()

Returns the interval width. This method will return either the auto calculated interval width or the manually specified interval width, depending on the isAutoWidth() result.

Returns
  • The interval width to use.

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.
item the item index.
Returns
  • The start value of the x-interval (possibly null).
See Also

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.
item the item index.
Returns
  • The start value of the x-interval.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

public boolean isAutoWidth ()

Returns true if the interval width is automatically calculated, and false otherwise.

Returns
  • A boolean.

public void setAutoWidth (boolean b)

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.

public void setFixedIntervalWidth (double w)

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).

public void setIntervalPositionFactor (double d)

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).