public class

DefaultBoxAndWhiskerXYDataset

extends AbstractXYDataset
implements RangeInfo BoxAndWhiskerXYDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.statistics.DefaultBoxAndWhiskerXYDataset

Class Overview

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

Summary

Public Constructors
DefaultBoxAndWhiskerXYDataset(Comparable seriesKey)
Constructs a new box and whisker dataset.
Public Methods
void add(Date date, BoxAndWhiskerItem item)
Adds an item to the dataset and sends a DatasetChangeEvent to all registered listeners.
Object clone()
Returns a clone of the plot.
boolean equals(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.
Number getMaxOutlier(int series, int item)
Returns the maximum value which is not a farout, ie Q3 + (interquartile range * farout coefficient).
Number getMaxRegularValue(int series, int item)
Returns the max-value for the specified series and item.
Number getMeanValue(int series, int item)
Returns the mean for the specified series and item.
Number getMedianValue(int series, int item)
Returns the median-value for the specified series and item.
Number getMinOutlier(int series, int item)
Returns the minimum value which is not a farout.
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.
List getOutliers(int series, int item)
Returns an array of outliers for the specified series and item.
Number getQ1Value(int series, int item)
Returns the Q1 median-value for the specified series and item.
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.
Comparable getSeriesKey(int i)
Returns the name of the series stored in this dataset.
Number getX(int series, int item)
Returns the x-value for one item in a series.
Date getXDate(int series, int item)
Returns the x-value for one item in a series, as a Date.
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
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.RangeInfo
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.statistics.BoxAndWhiskerXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public DefaultBoxAndWhiskerXYDataset (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.

Public Methods

public void add (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).

public Object clone ()

Returns a clone of the plot.

Returns
  • A clone.
Throws
CloneNotSupportedException if the cloning is not supported.

public boolean equals (Object obj)

Tests this dataset for equality with an arbitrary object.

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

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.

Returns
  • A double representing the value used to calculate farouts.
See Also

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.

public int getItemCount (int series)

Returns the number of items in the specified series.

Parameters
series the index (zero-based) of the series.
Returns
  • The number of items in the specified series.

public Number getMaxOutlier (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • A Number representing the maximum non-farout value.

public Number getMaxRegularValue (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The max-value for the specified series and item.

public Number getMeanValue (int series, int item)

Returns the mean for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The mean for the specified series and item.

public Number getMedianValue (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The median-value for the specified series and item.

public Number getMinOutlier (int series, int item)

Returns the minimum value which is not a farout.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • A Number representing the maximum non-farout value.

public Number getMinRegularValue (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The min-value for the specified series and item.

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

Returns
  • A double representing the value used to calculate outliers.
See Also

public List getOutliers (int series, int item)

Returns an array of outliers for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The array of outliers for the specified series and item.

public Number getQ1Value (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The Q1 median-value for the specified series and item.

public Number getQ3Value (int series, int item)

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The Q3 median-value for the specified series and item.

public Range getRangeBounds (boolean includeInterval)

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

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

public double getRangeLowerBound (boolean includeInterval)

Returns the minimum y-value in the dataset.

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

public double getRangeUpperBound (boolean includeInterval)

Returns the maximum y-value in the dataset.

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

public int getSeriesCount ()

Returns the number of series in the dataset.

This implementation only allows one series.

Returns
  • The number of series.

public Comparable getSeriesKey (int i)

Returns the name of the series stored in this dataset.

Parameters
i the index of the series. Currently ignored.
Returns
  • The name of this series.

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The x-value.

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

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

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The y-value.

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

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