Module org.jfree.chart

Package org.jfree.data.statistics

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

java.lang.Object

org.jfree.data.general.AbstractDataset

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

All Implemented Interfaces:

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

public class DefaultStatisticalCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>
extends AbstractDataset
implements StatisticalCategoryDataset<R,C>, RangeInfo, PublicCloneable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultStatisticalCategoryDataset()	Creates a new dataset.

Method Summary

Modifier and Type	Method	Description
void	add(double mean, double standardDeviation, R rowKey, C columnKey)	Adds a mean and standard deviation to the table.
void	add(Number mean, Number standardDeviation, R rowKey, C columnKey)	Adds a mean and standard deviation 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 instance 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.
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.
Range	getRangeBounds(boolean includeInterval)	Returns the bounds of the values in this dataset's y-values.
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	getStdDevValue(int row, int column)	Returns the standard deviation value for an item.
Number	getStdDevValue(R rowKey, C columnKey)	Returns the standard deviation value for an item.
Number	getValue(int row, int column)	Returns the value for an item (for this dataset, the mean value is returned).
Number	getValue(R rowKey, C columnKey)	Returns the value for an item (for this dataset, the mean value is returned).
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

Constructor Detail

DefaultStatisticalCategoryDataset

public DefaultStatisticalCategoryDataset()

Creates a new dataset.

Method Detail

getMeanValue

public Number getMeanValue(int row,
                           int column)

Returns the mean value for an item.

Specified by:

getMeanValue in interface StatisticalCategoryDataset<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 (possibly null).

getValue

public Number getValue(int row,
                       int column)

Returns the value for an item (for this dataset, the mean value is returned).

Specified by:

getValue in interface Values2D

Parameters:

row - the row index.

column - the column index.

Returns:

The value (possibly null).

getValue

public Number getValue(R rowKey,
                       C columnKey)

Returns the value for an item (for this dataset, the mean value is returned).

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 (possibly null).

getMeanValue

public Number getMeanValue(R rowKey,
                           C columnKey)

Returns the mean value for an item.

Specified by:

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

Parameters:

rowKey - the row key.

columnKey - the columnKey.

Returns:

The mean value (possibly null).

getStdDevValue

public Number getStdDevValue(int row,
                             int column)

Returns the standard deviation value for an item.

Specified by:

getStdDevValue in interface StatisticalCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The standard deviation (possibly null).

getStdDevValue

public Number getStdDevValue(R rowKey,
                             C columnKey)

Returns the standard deviation value for an item.

Specified by:

getStdDevValue in interface StatisticalCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key.

columnKey - the columnKey.

Returns:

The standard deviation (possibly null).

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.

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.

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.

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.

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.

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.

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()

add

public void add(double mean,
                double standardDeviation,
                R rowKey,
                C columnKey)

Adds a mean and standard deviation to the table.

Parameters:

mean - the mean.

standardDeviation - the standard deviation.

rowKey - the row key.

columnKey - the column key.

add

public void add(Number mean,
                Number standardDeviation,
                R rowKey,
                C columnKey)

Adds a mean and standard deviation to the table.

Parameters:

mean - the mean.

standardDeviation - the standard deviation.

rowKey - the row key.

columnKey - the column key.

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(double, double, 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 (null not permitted).

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 (null not permitted).

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

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 bounds of the values in this dataset's y-values.

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.

equals

public boolean equals(Object obj)

Tests this instance for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (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 of this dataset.

Throws:

CloneNotSupportedException - if cloning cannot be completed.