Package org.jfree.data.statistics

Class DefaultBoxAndWhiskerCategoryDataset

java.lang.Object
org.jfree.data.AbstractDataset
org.jfree.data.statistics.DefaultBoxAndWhiskerCategoryDataset
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, CategoryDataset, Dataset, KeyedValues2D, RangeInfo, BoxAndWhiskerCategoryDataset, Values2D
public class DefaultBoxAndWhiskerCategoryDataset
extends AbstractDataset
implements BoxAndWhiskerCategoryDataset, RangeInfo
A convenience class that provides a default implementation of the BoxAndWhiskerCategoryDataset interface.
Author:
David Browning (for Australian Institute of Marine Science)
See Also:
Serialized Form

  • Constructor Details

    • DefaultBoxAndWhiskerCategoryDataset

      public DefaultBoxAndWhiskerCategoryDataset()
      Creates a new dataset.

  • Method Details

    • getValue

      public Number getValue​(int row, int column)
      Returns the value for an item.
      Specified by:
      getValue in interface Values2D
      Parameters:
      row - the row index.
      column - the column index.
      Returns:
      the value.

    • getValue

      public Number getValue​(Comparable rowKey, Comparable columnKey)
      Returns the value for an item.
      Specified by:
      getValue in interface KeyedValues2D
      Parameters:
      rowKey - the row key.
      columnKey - the columnKey.
      Returns:
      the value.

    • getMeanValue

      public Number getMeanValue​(int row, int column)
      Returns the mean value for an item.
      Specified by:
      getMeanValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The mean value.

    • getMeanValue

      public Number getMeanValue​(Comparable rowKey, Comparable columnKey)
      Returns the mean value for an item.
      Specified by:
      getMeanValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The mean value.

    • getMedianValue

      public Number getMedianValue​(int row, int column)
      Returns the median value for an item.
      Specified by:
      getMedianValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      the median value.

    • getMedianValue

      public Number getMedianValue​(Comparable rowKey, Comparable columnKey)
      Returns the median value for an item.
      Specified by:
      getMedianValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the columnKey.
      Returns:
      the median value.

    • getQ1Value

      public Number getQ1Value​(int row, int column)
      Returns the first quartile value.
      Specified by:
      getQ1Value in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The first quartile value.

    • getQ1Value

      public Number getQ1Value​(Comparable rowKey, Comparable columnKey)
      Returns the first quartile value.
      Specified by:
      getQ1Value in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The first quartile value.

    • getQ3Value

      public Number getQ3Value​(int row, int column)
      Returns the third quartile value.
      Specified by:
      getQ3Value in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The third quartile value.

    • getQ3Value

      public Number getQ3Value​(Comparable rowKey, Comparable columnKey)
      Returns the third quartile value.
      Specified by:
      getQ3Value in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The third quartile value.

    • getColumnIndex

      public int getColumnIndex​(Comparable key)
      Returns the column index for a given key.
      Specified by:
      getColumnIndex in interface KeyedValues2D
      Parameters:
      key - the column key.
      Returns:
      the column index.

    • getColumnKey

      public Comparable getColumnKey​(int column)
      Returns a column key.
      Specified by:
      getColumnKey in interface KeyedValues2D
      Parameters:
      column - the column index (zero-based).
      Returns:
      the column key.

    • getColumnKeys

      public List getColumnKeys()
      Returns the column keys.
      Specified by:
      getColumnKeys in interface KeyedValues2D
      Returns:
      the keys.

    • getRowIndex

      public int getRowIndex​(Comparable key)
      Returns the row index for a given key.
      Specified by:
      getRowIndex in interface KeyedValues2D
      Parameters:
      key - the row key.
      Returns:
      the row index.

    • getRowKey

      public Comparable getRowKey​(int row)
      Returns a row key.
      Specified by:
      getRowKey in interface KeyedValues2D
      Parameters:
      row - the row index (zero-based).
      Returns:
      the row key.

    • getRowKeys

      public List getRowKeys()
      Returns the row keys.
      Specified by:
      getRowKeys in interface KeyedValues2D
      Returns:
      the keys.

    • getRowCount

      public int getRowCount()
      Returns the number of rows in the table.
      Specified by:
      getRowCount in interface Values2D
      Returns:
      the row count.

    • getColumnCount

      public int getColumnCount()
      Returns the number of columns in the table.
      Specified by:
      getColumnCount in interface Values2D
      Returns:
      the column count.

    • add

      public void add​(List list, Comparable rowKey, Comparable columnKey)
      Adds a list of values relating to one Box and Whisker entity to the table. The various median values are calculated.
      Parameters:
      list - a collection of values from which the various medians will be calculated.
      rowKey - the row key.
      columnKey - the column key.

    • add

      public void add​(BoxAndWhiskerItem item, Comparable rowKey, Comparable columnKey)
      Adds a list of values relating to one Box and Whisker entity to the table. The various median values are calculated.
      Parameters:
      item - a box and whisker item.
      rowKey - the row key.
      columnKey - the column key.

    • getMinimumRangeValue

      public Number getMinimumRangeValue()
      Returns the minimum value in the dataset's range (or null if all the values in the range are null).
      Specified by:
      getMinimumRangeValue in interface RangeInfo
      Returns:
      the minimum value.

    • getMaximumRangeValue

      public Number getMaximumRangeValue()
      Returns the maximum value in the dataset's range (or null if all the values in the range are null).
      Specified by:
      getMaximumRangeValue in interface RangeInfo
      Returns:
      the maximum value.

    • getValueRange

      public Range getValueRange()
      Returns the range of the values in this dataset's range.
      Specified by:
      getValueRange in interface RangeInfo
      Returns:
      the range.

    • getMinRegularValue

      public Number getMinRegularValue​(int row, int column)
      Returns the minimum regular (non outlier) value for an item.
      Specified by:
      getMinRegularValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The minimum regular value.

    • getMinRegularValue

      public Number getMinRegularValue​(Comparable rowKey, Comparable columnKey)
      Returns the minimum regular (non outlier) value for an item.
      Specified by:
      getMinRegularValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The minimum regular value.

    • getMaxRegularValue

      public Number getMaxRegularValue​(int row, int column)
      Returns the maximum regular (non outlier) value for an item.
      Specified by:
      getMaxRegularValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The maximum regular value.

    • getMaxRegularValue

      public Number getMaxRegularValue​(Comparable rowKey, Comparable columnKey)
      Returns the maximum regular (non outlier) value for an item.
      Specified by:
      getMaxRegularValue in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The maximum regular value.

    • getMinOutlier

      public Number getMinOutlier​(int row, int column)
      Returns the minimum outlier (non farout) value for an item.
      Specified by:
      getMinOutlier in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The minimum outlier.

    • getMinOutlier

      public Number getMinOutlier​(Comparable rowKey, Comparable columnKey)
      Returns the minimum outlier (non farout) value for an item.
      Specified by:
      getMinOutlier in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The minimum outlier.

    • getMaxOutlier

      public Number getMaxOutlier​(int row, int column)
      Returns the maximum outlier (non farout) value for an item.
      Specified by:
      getMaxOutlier in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      The maximum outlier.

    • getMaxOutlier

      public Number getMaxOutlier​(Comparable rowKey, Comparable columnKey)
      Returns the maximum outlier (non farout) value for an item.
      Specified by:
      getMaxOutlier in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      The maximum outlier.

    • getOutliers

      public List getOutliers​(int row, int column)
      Returns a list of outlier values for an item.
      Specified by:
      getOutliers in interface BoxAndWhiskerCategoryDataset
      Parameters:
      row - the row index (zero-based).
      column - the column index (zero-based).
      Returns:
      A list of outlier values.

    • getOutliers

      public List getOutliers​(Comparable rowKey, Comparable columnKey)
      Returns a list of outlier values for an item.
      Specified by:
      getOutliers in interface BoxAndWhiskerCategoryDataset
      Parameters:
      rowKey - the row key.
      columnKey - the column key.
      Returns:
      A list of outlier values.

    • equals

      public boolean equals​(Object obj)
      Tests this dataset for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test against (null permitted).
      Returns:
      a boolean.