org.jfree.data.statistics

Class DefaultBoxAndWhiskerXYDataset

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.general.AbstractSeriesDataset

org.jfree.data.xy.AbstractXYDataset

org.jfree.data.statistics.DefaultBoxAndWhiskerXYDataset

All Implemented Interfaces:

java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, Dataset, SeriesChangeListener, SeriesDataset, RangeInfo, BoxAndWhiskerXYDataset, XYDataset

public class DefaultBoxAndWhiskerXYDataset
extends AbstractXYDataset
implements BoxAndWhiskerXYDataset, RangeInfo

A simple implementation of the BoxAndWhiskerXYDataset interface. This dataset implementation can hold only one series.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List	dates Storage for the dates.
private double	faroutCoefficient The coefficient used to calculate farouts.
private java.util.List	items Storage for the box and whisker statistics.
private java.lang.Number	maximumRangeValue The maximum range value.
private java.lang.Number	minimumRangeValue The minimum range value.
private double	outlierCoefficient The coefficient used to calculate outliers.
private Range	rangeBounds The range of values.
private java.lang.Comparable	seriesKey The series key.

Constructor Summary

Constructors

Constructor and Description
DefaultBoxAndWhiskerXYDataset(java.lang.Comparable seriesKey) Constructs a new box and whisker dataset.

Method Summary

Modifier and Type	Method and Description
void	add(java.util.Date date, BoxAndWhiskerItem item) Adds an item to the dataset and sends a DatasetChangeEvent to all registered listeners.
java.lang.Object	clone() Returns a clone of the plot.
boolean	equals(java.lang.Object obj) Tests this dataset for equality with an arbitrary object.
double	getFaroutCoefficient() Returns the value used as the farout coefficient.
BoxAndWhiskerItem	getItem(int series, int item) Return an item from within the dataset.
int	getItemCount(int series) Returns the number of items in the specified series.
java.lang.Number	getMaxOutlier(int series, int item) Returns the maximum value which is not a farout, ie Q3 + (interquartile range * farout coefficient).
java.lang.Number	getMaxRegularValue(int series, int item) Returns the max-value for the specified series and item.
java.lang.Number	getMeanValue(int series, int item) Returns the mean for the specified series and item.
java.lang.Number	getMedianValue(int series, int item) Returns the median-value for the specified series and item.
java.lang.Number	getMinOutlier(int series, int item) Returns the minimum value which is not a farout.
java.lang.Number	getMinRegularValue(int series, int item) Returns the min-value for the specified series and item.
double	getOutlierCoefficient() Returns the value used as the outlier coefficient.
java.util.List	getOutliers(int series, int item) Returns a list of outliers for the specified series and item.
java.lang.Number	getQ1Value(int series, int item) Returns the Q1 median-value for the specified series and item.
java.lang.Number	getQ3Value(int series, int item) Returns the Q3 median-value for the specified series and item.
Range	getRangeBounds(boolean includeInterval) Returns the range of the values in this dataset's range.
double	getRangeLowerBound(boolean includeInterval) Returns the minimum y-value in the dataset.
double	getRangeUpperBound(boolean includeInterval) Returns the maximum y-value in the dataset.
int	getSeriesCount() Returns the number of series in the dataset.
java.lang.Comparable	getSeriesKey(int i) Returns the name of the series stored in this dataset.
java.lang.Number	getX(int series, int item) Returns the x-value for one item in a series.
java.util.Date	getXDate(int series, int item) Returns the x-value for one item in a series, as a Date.
java.lang.Number	getY(int series, int item) Returns the y-value for one item in a series.
void	setFaroutCoefficient(double faroutCoefficient) Sets the value used as the farouts coefficient.
void	setOutlierCoefficient(double outlierCoefficient) Sets the value used as the outlier coefficient

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, fireDatasetChanged, getGroup, getNotify, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.data.xy.XYDataset

getDomainOrder, getXValue, getYValue

Methods inherited from interface org.jfree.data.general.SeriesDataset

indexOf

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Field Detail

seriesKey

private java.lang.Comparable seriesKey

The series key.

dates

private java.util.List dates

Storage for the dates.

items

private java.util.List items

Storage for the box and whisker statistics.

minimumRangeValue

private java.lang.Number minimumRangeValue

The minimum range value.

maximumRangeValue

private java.lang.Number maximumRangeValue

The maximum range value.

rangeBounds

private Range rangeBounds

The range of values.

outlierCoefficient

private double outlierCoefficient

The coefficient used to calculate outliers. Tukey's default value is 1.5 (see EDA) Any value which is greater than Q3 + (interquartile range * outlier coefficient) is considered to be an outlier. Can be altered if the data is particularly skewed.

faroutCoefficient

private double faroutCoefficient

The coefficient used to calculate farouts. Tukey's default value is 2 (see EDA) Any value which is greater than Q3 + (interquartile range * farout coefficient) is considered to be a farout. Can be altered if the data is particularly skewed.

Constructor Detail

DefaultBoxAndWhiskerXYDataset

public DefaultBoxAndWhiskerXYDataset(java.lang.Comparable seriesKey)

Constructs a new box and whisker dataset.

The current implementation allows only one series in the dataset. This may be extended in a future version.

Parameters:

seriesKey - the key for the series.

Method Detail

getOutlierCoefficient

public double getOutlierCoefficient()

Returns the value used as the outlier coefficient. The outlier coefficient gives an indication of the degree of certainty in an unskewed distribution. Increasing the coefficient increases the number of values included. Currently only used to ensure farout coefficient is greater than the outlier coefficient

Specified by:

getOutlierCoefficient in interface BoxAndWhiskerXYDataset

Returns:

A double representing the value used to calculate outliers.

See Also:

setOutlierCoefficient(double)

setOutlierCoefficient

public void setOutlierCoefficient(double outlierCoefficient)

Sets the value used as the outlier coefficient

Parameters:

outlierCoefficient - being a double representing the value used to calculate outliers.

See Also:

getOutlierCoefficient()

getFaroutCoefficient

public double getFaroutCoefficient()

Returns the value used as the farout coefficient. The farout coefficient allows the calculation of which values will be off the graph.

Specified by:

getFaroutCoefficient in interface BoxAndWhiskerXYDataset

Returns:

A double representing the value used to calculate farouts.

See Also:

setFaroutCoefficient(double)

setFaroutCoefficient

public void setFaroutCoefficient(double faroutCoefficient)

Sets the value used as the farouts coefficient. The farout coefficient must b greater than the outlier coefficient.

Parameters:

faroutCoefficient - being a double representing the value used to calculate farouts.

See Also:

getFaroutCoefficient()

getSeriesCount

public int getSeriesCount()

Returns the number of series in the dataset.

This implementation only allows one series.

Specified by:

getSeriesCount in interface SeriesDataset

Specified by:

getSeriesCount in class AbstractSeriesDataset

Returns:

The number of series.

getItemCount

public int getItemCount(int series)

Returns the number of items in the specified series.

Specified by:

getItemCount in interface XYDataset

Parameters:

series - the index (zero-based) of the series.

Returns:

The number of items in the specified series.

add

public void add(java.util.Date date,
                BoxAndWhiskerItem item)

Adds an item to the dataset and sends a DatasetChangeEvent to all registered listeners.

Parameters:

date - the date (null not permitted).

item - the item (null not permitted).

getSeriesKey

public java.lang.Comparable getSeriesKey(int i)

Returns the name of the series stored in this dataset.

Specified by:

getSeriesKey in interface SeriesDataset

Specified by:

getSeriesKey in class AbstractSeriesDataset

Parameters:

i - the index of the series. Currently ignored.

Returns:

The name of this series.

getItem

public BoxAndWhiskerItem getItem(int series,
                                 int item)

Return an item from within the dataset.

Parameters:

series - the series index (ignored, since this dataset contains only one series).

item - the item within the series (zero-based index)

Returns:

The item.

getX

public java.lang.Number getX(int series,
                             int item)

Returns the x-value for one item in a series.

The value returned is a Long object generated from the underlying Date object.

Specified by:

getX in interface XYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The x-value.

getXDate

public java.util.Date getXDate(int series,
                               int item)

Returns the x-value for one item in a series, as a Date.

This method is provided for convenience only.

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The x-value as a Date.

getY

public java.lang.Number getY(int series,
                             int item)

Returns the y-value for one item in a series.

This method (from the XYDataset interface) is mapped to the getMeanValue() method.

Specified by:

getY in interface XYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The y-value.

getMeanValue

public java.lang.Number getMeanValue(int series,
                                     int item)

Returns the mean for the specified series and item.

Specified by:

getMeanValue in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The mean for the specified series and item.

getMedianValue

public java.lang.Number getMedianValue(int series,
                                       int item)

Returns the median-value for the specified series and item.

Specified by:

getMedianValue in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The median-value for the specified series and item.

getQ1Value

public java.lang.Number getQ1Value(int series,
                                   int item)

Returns the Q1 median-value for the specified series and item.

Specified by:

getQ1Value in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The Q1 median-value for the specified series and item.

getQ3Value

public java.lang.Number getQ3Value(int series,
                                   int item)

Returns the Q3 median-value for the specified series and item.

Specified by:

getQ3Value in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The Q3 median-value for the specified series and item.

getMinRegularValue

public java.lang.Number getMinRegularValue(int series,
                                           int item)

Returns the min-value for the specified series and item.

Specified by:

getMinRegularValue in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The min-value for the specified series and item.

getMaxRegularValue

public java.lang.Number getMaxRegularValue(int series,
                                           int item)

Returns the max-value for the specified series and item.

Specified by:

getMaxRegularValue in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The max-value for the specified series and item.

getMinOutlier

public java.lang.Number getMinOutlier(int series,
                                      int item)

Returns the minimum value which is not a farout.

Specified by:

getMinOutlier in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

A Number representing the maximum non-farout value.

getMaxOutlier

public java.lang.Number getMaxOutlier(int series,
                                      int item)

Returns the maximum value which is not a farout, ie Q3 + (interquartile range * farout coefficient).

Specified by:

getMaxOutlier in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

A Number representing the maximum non-farout value.

getOutliers

public java.util.List getOutliers(int series,
                                  int item)

Returns a list of outliers for the specified series and item.

Specified by:

getOutliers in interface BoxAndWhiskerXYDataset

Parameters:

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The list of outliers for the specified series and item (possibly null).

getRangeLowerBound

public double getRangeLowerBound(boolean includeInterval)

Returns the minimum y-value in the dataset.

Specified by:

getRangeLowerBound in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

Returns:

The minimum value.

getRangeUpperBound

public double getRangeUpperBound(boolean includeInterval)

Returns the maximum y-value in the dataset.

Specified by:

getRangeUpperBound in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

Returns:

The maximum value.

getRangeBounds

public Range getRangeBounds(boolean includeInterval)

Returns the range of the values in this dataset's range.

Specified by:

getRangeBounds in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

Returns:

The range.

equals

public boolean equals(java.lang.Object obj)

Tests this dataset for equality with an arbitrary object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of the plot.

Overrides:

clone in class AbstractDataset

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if the cloning is not supported.