Package org.jfree.data.statistics

Interface BoxAndWhiskerXYDataset

All Superinterfaces:
Dataset, SeriesDataset, XYDataset
All Known Implementing Classes:
DefaultBoxAndWhiskerXYDataset
public interface BoxAndWhiskerXYDataset
extends XYDataset
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.

Author:
David Browning

  • Method Details

    • getMeanValue

      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.

    • getMedianValue

      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.

    • getQ1Value

      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.

    • getQ3Value

      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.

    • getMinRegularValue

      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.

    • getMaxRegularValue

      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.

    • getMinOutlier

      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.

    • getMaxOutlier

      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.

    • getOutliers

      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.

    • getOutlierCoefficient

      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

    • getFaroutCoefficient

      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