Module org.jfree.chart

Package org.jfree.data.statistics

Class DefaultBoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.statistics.DefaultBoxAndWhiskerCategoryDataset<R,C>

All Implemented Interfaces:

ObjectInputValidation, Serializable, Cloneable, PublicCloneable, CategoryDataset<R,C>, Dataset, KeyedValues2D<R,C>, RangeInfo, BoxAndWhiskerCategoryDataset<R,C>, Values2D

public class DefaultBoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>
extends AbstractDataset
implements BoxAndWhiskerCategoryDataset<R,C>, RangeInfo, PublicCloneable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected KeyedObjects2D<R,C>	data	Storage for the data.

Constructor Summary

Constructors

Constructor	Description
DefaultBoxAndWhiskerCategoryDataset()	Creates a new dataset.

Method Summary

Modifier and Type	Method	Description
void	add(List<? extends Number> list, R rowKey, C columnKey)	Adds a list of values relating to one box-and-whisker entity to the table.
void	add(BoxAndWhiskerItem item, R rowKey, C 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(C key)	Returns the column index for a given key.
C	getColumnKey(int column)	Returns a column key.
List<C>	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(R rowKey, C 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(R rowKey, C 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(R rowKey, C columnKey)	Returns the mean value for an item.
Number	getMedianValue(int row, int column)	Returns the median value for an item.
Number	getMedianValue(R rowKey, C 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(R rowKey, C 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(R rowKey, C columnKey)	Returns the minimum regular (non outlier) value for an item.
List<? extends Number>	getOutliers(int row, int column)	Returns a list of outlier values for an item.
List<? extends Number>	getOutliers(R rowKey, C columnKey)	Returns a list of outlier values for an item.
Number	getQ1Value(int row, int column)	Returns the first quartile value.
Number	getQ1Value(R rowKey, C columnKey)	Returns the first quartile value.
Number	getQ3Value(int row, int column)	Returns the third quartile value.
Number	getQ3Value(R rowKey, C 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(R key)	Returns the row index for a given key.
R	getRowKey(int row)	Returns a row key.
List<R>	getRowKeys()	Returns the row keys.
Number	getValue(int row, int column)	Returns the value for an item.
Number	getValue(R rowKey, C columnKey)	Returns the value for an item.
int	hashCode()
void	remove(R rowKey, C 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(C 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(R rowKey)	Removes a row from the dataset and sends a DatasetChangeEvent to all registered listeners.

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, fireDatasetChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotify, validateObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, removeChangeListener

Field Detail

data

protected KeyedObjects2D<R extends Comparable<R>,C extends Comparable<C>> data

Storage for the data.

Constructor Detail

DefaultBoxAndWhiskerCategoryDataset

public DefaultBoxAndWhiskerCategoryDataset()

Creates a new dataset.

Method Detail

add

public void add(List<? extends Number> list,
                R rowKey,
                C 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).

See Also:

add(BoxAndWhiskerItem, Comparable, Comparable)

add

public void add(BoxAndWhiskerItem item,
                R rowKey,
                C 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).

See Also:

add(List, Comparable, Comparable)

remove

public void remove(R rowKey,
                   C columnKey)

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

Parameters:

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

Since:

1.0.7

See Also:

add(BoxAndWhiskerItem, Comparable, Comparable)

removeRow

public void removeRow(int rowIndex)

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

Parameters:

rowIndex - the row index.

Since:

1.0.7

See Also:

removeColumn(int)

removeRow

public void removeRow(R 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:

removeColumn(Comparable)

removeColumn

public void removeColumn(int columnIndex)

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

Parameters:

columnIndex - the column index.

Since:

1.0.7

See Also:

removeRow(int)

removeColumn

public void removeColumn(C columnKey)

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

Parameters:

columnKey - the column key.

Since:

1.0.7

See Also:

removeRow(Comparable)

clear

public void clear()

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

Since:

1.0.7

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.

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.

See Also:

getMedianValue(int, int), getValue(Comparable, Comparable)

getValue

public Number getValue(R rowKey,
                       C columnKey)

Returns the value for an item.

Specified by:

getValue in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the columnKey.

Returns:

The value.

See Also:

getMedianValue(Comparable, Comparable), getValue(int, int)

getMeanValue

public Number getMeanValue(int row,
                           int column)

Returns the mean value for an item.

Specified by:

getMeanValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The mean value.

See Also:

getItem(int, int)

getMeanValue

public Number getMeanValue(R rowKey,
                           C columnKey)

Returns the mean value for an item.

Specified by:

getMeanValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The mean value.

See Also:

getItem(int, int)

getMedianValue

public Number getMedianValue(int row,
                             int column)

Returns the median value for an item.

Specified by:

getMedianValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The median value.

See Also:

getItem(int, int)

getMedianValue

public Number getMedianValue(R rowKey,
                             C columnKey)

Returns the median value for an item.

Specified by:

getMedianValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the columnKey.

Returns:

The median value.

See Also:

getItem(int, int)

getQ1Value

public Number getQ1Value(int row,
                         int column)

Returns the first quartile value.

Specified by:

getQ1Value in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The first quartile value.

See Also:

getItem(int, int)

getQ1Value

public Number getQ1Value(R rowKey,
                         C columnKey)

Returns the first quartile value.

Specified by:

getQ1Value in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The first quartile value.

See Also:

getItem(int, int)

getQ3Value

public Number getQ3Value(int row,
                         int column)

Returns the third quartile value.

Specified by:

getQ3Value in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The third quartile value.

See Also:

getItem(int, int)

getQ3Value

public Number getQ3Value(R rowKey,
                         C columnKey)

Returns the third quartile value.

Specified by:

getQ3Value in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The third quartile value.

See Also:

getItem(int, int)

getColumnIndex

public int getColumnIndex(C key)

Returns the column index for a given key.

Specified by:

getColumnIndex in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

key - the column key (null not permitted).

Returns:

The column index.

See Also:

getColumnKey(int)

getColumnKey

public C getColumnKey(int column)

Returns a column key.

Specified by:

getColumnKey in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

column - the column index (zero-based).

Returns:

The column key.

See Also:

getColumnIndex(Comparable)

getColumnKeys

public List<C> getColumnKeys()

Returns the column keys.

Specified by:

getColumnKeys in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Returns:

The keys.

See Also:

getRowKeys()

getRowIndex

public int getRowIndex(R key)

Returns the row index for a given key.

Specified by:

getRowIndex in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

key - the row key (null not permitted).

Returns:

The row index.

See Also:

getRowKey(int)

getRowKey

public R getRowKey(int row)

Returns a row key.

Specified by:

getRowKey in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

Returns:

The row key.

See Also:

getRowIndex(Comparable)

getRowKeys

public List<R> getRowKeys()

Returns the row keys.

Specified by:

getRowKeys in interface KeyedValues2D<R extends Comparable<R>,C extends Comparable<C>>

Returns:

The keys.

See Also:

getColumnKeys()

getRowCount

public int getRowCount()

Returns the number of rows in the table.

Specified by:

getRowCount in interface Values2D

Returns:

The row count.

See Also:

getColumnCount()

getColumnCount

public int getColumnCount()

Returns the number of columns in the table.

Specified by:

getColumnCount in interface Values2D

Returns:

The column count.

See Also:

getRowCount()

getRangeLowerBound

public double getRangeLowerBound(boolean includeInterval)

Returns the minimum y-value in the dataset.

Specified by:

getRangeLowerBound in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

Returns:

The minimum value.

See Also:

getRangeUpperBound(boolean)

getRangeUpperBound

public double getRangeUpperBound(boolean includeInterval)

Returns the maximum y-value in the dataset.

Specified by:

getRangeUpperBound in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

Returns:

The maximum value.

See Also:

getRangeLowerBound(boolean)

getRangeBounds

public Range getRangeBounds(boolean includeInterval)

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

Specified by:

getRangeBounds in interface RangeInfo

Parameters:

includeInterval - a flag that determines whether or not the y-interval is taken into account.

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<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The minimum regular value.

See Also:

getItem(int, int)

getMinRegularValue

public Number getMinRegularValue(R rowKey,
                                 C columnKey)

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

Specified by:

getMinRegularValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The minimum regular value.

See Also:

getItem(int, int)

getMaxRegularValue

public Number getMaxRegularValue(int row,
                                 int column)

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

Specified by:

getMaxRegularValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The maximum regular value.

See Also:

getItem(int, int)

getMaxRegularValue

public Number getMaxRegularValue(R rowKey,
                                 C columnKey)

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

Specified by:

getMaxRegularValue in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The maximum regular value.

See Also:

getItem(int, int)

getMinOutlier

public Number getMinOutlier(int row,
                            int column)

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

Specified by:

getMinOutlier in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The minimum outlier.

See Also:

getItem(int, int)

getMinOutlier

public Number getMinOutlier(R rowKey,
                            C columnKey)

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

Specified by:

getMinOutlier in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The minimum outlier.

See Also:

getItem(int, int)

getMaxOutlier

public Number getMaxOutlier(int row,
                            int column)

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

Specified by:

getMaxOutlier in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The maximum outlier.

See Also:

getItem(int, int)

getMaxOutlier

public Number getMaxOutlier(R rowKey,
                            C columnKey)

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

Specified by:

getMaxOutlier in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

The maximum outlier.

See Also:

getItem(int, int)

getOutliers

public List<? extends Number> getOutliers(int row,
                                          int column)

Returns a list of outlier values for an item.

Specified by:

getOutliers in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

A list of outlier values.

See Also:

getItem(int, int)

getOutliers

public List<? extends Number> getOutliers(R rowKey,
                                          C columnKey)

Returns a list of outlier values for an item.

Specified by:

getOutliers in interface BoxAndWhiskerCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

A list of outlier values.

See Also:

getItem(int, int)

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this dataset.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDataset

Returns:

A clone.

Throws:

CloneNotSupportedException - if cloning is not possible.