org.jfree.data.statistics

Class DefaultMultiValueCategoryDataset

Implemented Interfaces:
CategoryDataset, Cloneable, Dataset, KeyedValues2D, MultiValueCategoryDataset, ObjectInputValidation, PublicCloneable, RangeInfo, Serializable, Values2D

public class DefaultMultiValueCategoryDataset
extends AbstractDataset
implements MultiValueCategoryDataset, RangeInfo, PublicCloneable

A category dataset that defines multiple values for each item.
Since:
1.0.7

Field Summary

protected KeyedObjects2D
data
Storage for the data.

Constructor Summary

DefaultMultiValueCategoryDataset()
Creates a new dataset.

Method Summary

void
add(List values, Comparable rowKey, Comparable columnKey)
Adds a list of values to the dataset (null and Double.NaN items are automatically removed) and sends a DatasetChangeEvent to all registered listeners.
Object
clone()
Returns a clone of this instance.
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.
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(Comparable row, Comparable column)
Returns the average value for the specified item.
Number
getValue(int row, int column)
Returns the average value for the specified item.
List
getValues(Comparable rowKey, Comparable columnKey)
Returns a list (possibly empty) of the values for the specified item.
List
getValues(int row, int column)
Returns a list (possibly empty) of the values for the specified item.

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

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Field Details

data

protected KeyedObjects2D data
Storage for the data.

Constructor Details

DefaultMultiValueCategoryDataset

public DefaultMultiValueCategoryDataset()
Creates a new dataset.

Method Details

add

public void add(List values,
                Comparable rowKey,
                Comparable columnKey)
Adds a list of values to the dataset (null and Double.NaN items are automatically removed) and sends a DatasetChangeEvent to all registered listeners.
Parameters:
values - a list of values (null not permitted).
rowKey - the row key (null not permitted).
columnKey - the column key (null not permitted).

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Overrides:
clone in interface AbstractDataset
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getColumnCount

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

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.

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.

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.

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.

getRowCount

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

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.

getValue

public Number getValue(Comparable row,
                       Comparable column)
Returns the average value for the specified item.
Specified by:
getValue in interface KeyedValues2D
Parameters:
row - the row key.
column - the column key.
Returns:
The average value.

getValue

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

getValues

public List getValues(Comparable rowKey,
                      Comparable columnKey)
Returns a list (possibly empty) of the values for the specified item. The returned list should be unmodifiable.
Specified by:
getValues in interface MultiValueCategoryDataset
Parameters:
rowKey - the row key (null not permitted).
columnKey - the column key (null not permitted).
Returns:
The list of values.

getValues

public List getValues(int row,
                      int column)
Returns a list (possibly empty) of the values for the specified item. The returned list should be unmodifiable.
Specified by:
getValues in interface MultiValueCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The list of values.