Module org.jfree.chart

Package org.jfree.data.statistics

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

java.lang.Object

org.jfree.data.general.AbstractDataset

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

All Implemented Interfaces:

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

public class DefaultMultiValueCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>
extends AbstractDataset
implements MultiValueCategoryDataset<R,C>, RangeInfo, PublicCloneable

A category dataset that defines multiple values for each item.

Since:

1.0.7

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected KeyedObjects2D	data	Storage for the data.

Constructor Summary

Constructors

Constructor	Description
DefaultMultiValueCategoryDataset()	Creates a new dataset.

Method Summary

Modifier and Type	Method	Description
void	add(List<? extends Number> values, R rowKey, C 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.
C	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.
R	getRowKey(int row)	Returns a row key.
List	getRowKeys()	Returns the row keys.
Number	getValue(int row, int column)	Returns the average value for the specified item.
Number	getValue(Comparable row, Comparable column)	Returns the average value for the specified item.
List<? extends Number>	getValues(int row, int column)	Returns a list (possibly empty) of the values for the specified item.
List<? extends Number>	getValues(Comparable rowKey, Comparable columnKey)	Returns a list (possibly empty) of the values for the specified item.
int	hashCode()

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 data

Storage for the data.

Constructor Detail

DefaultMultiValueCategoryDataset

public DefaultMultiValueCategoryDataset()

Creates a new dataset.

Method Detail

add

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

getValues

public List<? extends Number> 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<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The list of values.

getValues

public List<? extends Number> 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<R extends Comparable<R>,C extends Comparable<C>>

Parameters:

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

Returns:

The list of values.

getValue

public Number getValue(Comparable row,
                       Comparable column)

Returns the average value for the specified item.

Specified by:

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

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.

getColumnIndex

public int getColumnIndex(Comparable 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.

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 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(Comparable 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.

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 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.

getColumnCount

public int getColumnCount()

Returns the number of columns in the table.

Specified by:

getColumnCount in interface Values2D

Returns:

The column count.

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.

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.

equals

public boolean equals(Object obj)

Tests this dataset 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 instance.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDataset

Returns:

A clone.

Throws:

CloneNotSupportedException - if the dataset cannot be cloned.