public interface

BoxAndWhiskerXYDataset

implements XYDataset
org.jfree.data.statistics.BoxAndWhiskerXYDataset
Known Indirect Subclasses

Class Overview

An interface that defines data in the form of (x, max, min, average, median) tuples.

Example: JFreeChart uses this interface to obtain data for AIMS max-min-average-median plots.

Summary

Public Methods
abstract double getFaroutCoefficient()
Returns the value used as the farout coefficient.
abstract Number getMaxOutlier(int series, int item)
Returns the maximum value which is not a farout, ie Q3 + (interquartile range * farout coefficient).
abstract Number getMaxRegularValue(int series, int item)
Returns the max-value for the specified series and item.
abstract Number getMeanValue(int series, int item)
Returns the mean for the specified series and item.
abstract Number getMedianValue(int series, int item)
Returns the median-value for the specified series and item.
abstract Number getMinOutlier(int series, int item)
Returns the minimum value which is not a farout.
abstract Number getMinRegularValue(int series, int item)
Returns the min-value for the specified series and item.
abstract double getOutlierCoefficient()
Returns the value used as the outlier coefficient.
abstract List getOutliers(int series, int item)
Returns an array of outliers for the specified series and item.
abstract Number getQ1Value(int series, int item)
Returns the Q1 median-value for the specified series and item.
abstract Number getQ3Value(int series, int item)
Returns the Q3 median-value for the specified series and item.
[Expand]
Inherited Methods
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.XYDataset

Public Methods

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

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

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