org.jfree.data.statistics

Class DefaultBoxAndWhiskerCategoryDataset

public class DefaultBoxAndWhiskerCategoryDataset extends AbstractDataset implements BoxAndWhiskerCategoryDataset, RangeInfo, PublicCloneable

A convenience class that provides a default implementation of the BoxAndWhiskerCategoryDataset interface.

Field Summary
protected KeyedObjects2D	data Storage for the data.

Constructor Summary
	DefaultBoxAndWhiskerCategoryDataset() Creates a new dataset.

Method Summary
void	add(List list, Comparable rowKey, Comparable columnKey) Adds a list of values relating to one box-and-whisker entity to the table.
void	add(BoxAndWhiskerItem item, Comparable rowKey, Comparable columnKey) Adds a list of values relating to one Box and Whisker entity to the table.
void	clear() Clears all data from the dataset and sends a DatasetChangeEvent to all registered listeners.
Object	clone() Returns a clone of this dataset.
boolean	equals(Object obj) Tests this dataset for equality with an arbitrary object.
int	getColumnCount() Returns the number of columns in the table.
int	getColumnIndex(Comparable key) Returns the column index for a given key.
Comparable	getColumnKey(int column) Returns a column key.
List	getColumnKeys() Returns the column keys.
BoxAndWhiskerItem	getItem(int row, int column) Return an item from within the dataset.
Number	getMaxOutlier(int row, int column) Returns the maximum outlier (non farout) value for an item.
Number	getMaxOutlier(Comparable rowKey, Comparable columnKey) Returns the maximum outlier (non farout) value for an item.
Number	getMaxRegularValue(int row, int column) Returns the maximum regular (non outlier) value for an item.
Number	getMaxRegularValue(Comparable rowKey, Comparable columnKey) Returns the maximum regular (non outlier) value for an item.
Number	getMeanValue(int row, int column) Returns the mean value for an item.
Number	getMeanValue(Comparable rowKey, Comparable columnKey) Returns the mean value for an item.
Number	getMedianValue(int row, int column) Returns the median value for an item.
Number	getMedianValue(Comparable rowKey, Comparable columnKey) Returns the median value for an item.
Number	getMinOutlier(int row, int column) Returns the minimum outlier (non farout) value for an item.
Number	getMinOutlier(Comparable rowKey, Comparable columnKey) Returns the minimum outlier (non farout) value for an item.
Number	getMinRegularValue(int row, int column) Returns the minimum regular (non outlier) value for an item.
Number	getMinRegularValue(Comparable rowKey, Comparable columnKey) Returns the minimum regular (non outlier) value for an item.
List	getOutliers(int row, int column) Returns a list of outlier values for an item.
List	getOutliers(Comparable rowKey, Comparable columnKey) Returns a list of outlier values for an item.
Number	getQ1Value(int row, int column) Returns the first quartile value.
Number	getQ1Value(Comparable rowKey, Comparable columnKey) Returns the first quartile value.
Number	getQ3Value(int row, int column) Returns the third quartile value.
Number	getQ3Value(Comparable rowKey, Comparable columnKey) Returns the third quartile value.
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	getRowCount() Returns the number of rows in the table.
int	getRowIndex(Comparable key) Returns the row index for a given key.
Comparable	getRowKey(int row) Returns a row key.
List	getRowKeys() Returns the row keys.
Number	getValue(int row, int column) Returns the value for an item.
Number	getValue(Comparable rowKey, Comparable columnKey) Returns the value for an item.
void	remove(Comparable rowKey, Comparable columnKey) Removes an item from the dataset and sends a DatasetChangeEvent to all registered listeners.
void	removeColumn(int columnIndex) Removes a column from the dataset and sends a DatasetChangeEvent to all registered listeners.
void	removeColumn(Comparable columnKey) Removes a column from the dataset and sends a DatasetChangeEvent to all registered listeners.
void	removeRow(int rowIndex) Removes a row from the dataset and sends a DatasetChangeEvent to all registered listeners.
void	removeRow(Comparable rowKey) Removes a row from the dataset and sends a DatasetChangeEvent to all registered listeners.

Field Detail

data

protected KeyedObjects2D data

Storage for the data.

Constructor Detail

DefaultBoxAndWhiskerCategoryDataset

public DefaultBoxAndWhiskerCategoryDataset()

Creates a new dataset.

Method Detail

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 (null not permitted). columnKey the column key (null not permitted).

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 (null not permitted). rowKey the row key (null not permitted). columnKey the column key (null not permitted).

clear

public void clear()

Clears all data from the dataset and sends a DatasetChangeEvent to all registered listeners.

Since: 1.0.7

clone

public Object clone()

Returns a clone of this dataset.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not possible.

equals

public boolean equals(Object obj)

Tests this dataset for equality with an arbitrary object.

Parameters: obj the object to test against (null permitted).

Returns: A boolean.

getColumnCount

public int getColumnCount()

Returns the number of columns in the table.

Returns: The column count.

getColumnIndex

public int getColumnIndex(Comparable key)

Returns the column index for a given key.

Parameters: key the column key (null not permitted).

Returns: The column index.

getColumnKey

public Comparable getColumnKey(int column)

Returns a column key.

Parameters: column the column index (zero-based).

Returns: The column key.

getColumnKeys

public List getColumnKeys()

Returns the column keys.

Returns: The keys.

getItem

public BoxAndWhiskerItem getItem(int row, int column)

Return an item from within the dataset.

Parameters: row the row index. column the column index.

Returns: The item.

getMaxOutlier

public Number getMaxOutlier(int row, int column)

Returns the maximum outlier (non farout) value for an item.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: The maximum outlier.

getMaxRegularValue

public Number getMaxRegularValue(int row, int column)

Returns the maximum regular (non outlier) value for an item.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: The maximum regular value.

getMeanValue

public Number getMeanValue(int row, int column)

Returns the mean value for an item.

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.

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.

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.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The median value.

getMinOutlier

public Number getMinOutlier(int row, int column)

Returns the minimum outlier (non farout) value for an item.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: The minimum outlier.

getMinRegularValue

public Number getMinRegularValue(int row, int column)

Returns the minimum regular (non outlier) value for an item.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: The minimum regular value.

getOutliers

public List getOutliers(int row, int column)

Returns a list of outlier values for an item.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: A list of outlier values.

getQ1Value

public Number getQ1Value(int row, int column)

Returns the first quartile value.

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.

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.

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.

Parameters: rowKey the row key. columnKey the column key.

Returns: The third quartile value.

getRangeBounds

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.

getRangeLowerBound

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.

getRangeUpperBound

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.

getRowCount

public int getRowCount()

Returns the number of rows in the table.

Returns: The row count.

getRowIndex

public int getRowIndex(Comparable key)

Returns the row index for a given key.

Parameters: key the row key (null not permitted).

Returns: The row index.

getRowKey

public Comparable getRowKey(int row)

Returns a row key.

Parameters: row the row index (zero-based).

Returns: The row key.

getRowKeys

public List getRowKeys()

Returns the row keys.

Returns: The keys.

getValue

public Number getValue(int row, int column)

Returns the value for an item.

Parameters: row the row index. column the column index.

Returns: The value.

public void removeRow(Comparable rowKey)

Removes a row from the dataset and sends a DatasetChangeEvent to all registered listeners.

Parameters: rowKey the row key.

Since: 1.0.7

See Also:

HeaderAnd More

Class DefaultBoxAndWhiskerCategoryDataset

FooterAnd More

Header
And More

Footer
And More