Module org.jfree.chart

Package org.jfree.data.category

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

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.category.DefaultCategoryDataset<R,C>

Type Parameters:

R - The type for the row (series) keys.

C - The type for the column (item) keys.

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultKeyedValues2DDataset

public class DefaultCategoryDataset<R extends Comparable<R>,C extends Comparable<C>>
extends AbstractDataset
implements CategoryDataset<R,C>, PublicCloneable, Serializable

A default implementation of the CategoryDataset interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultCategoryDataset()	Creates a new (empty) dataset.

Method Summary

Modifier and Type	Method	Description
void	addValue(double value, R rowKey, C columnKey)	Adds a value to the table.
void	addValue(Number value, R rowKey, C columnKey)	Adds a value 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 the 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.
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 the key for the specified row.
List<R>	getRowKeys()	Returns the row keys.
Number	getValue(int row, int column)	Returns a value from the table.
Number	getValue(R rowKey, C columnKey)	Returns the value for a pair of keys.
int	hashCode()	Returns a hash code for the dataset.
void	incrementValue(double value, R rowKey, C columnKey)	Adds the specified value to an existing value in the dataset (if the existing value is null, it is treated as if it were 0.0).
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.
void	removeValue(R rowKey, C columnKey)	Removes a value from the dataset and sends a DatasetChangeEvent to all registered listeners.
void	setValue(double value, R rowKey, C columnKey)	Adds or updates a value in the table and sends a DatasetChangeEvent to all registered listeners.
void	setValue(Number value, R rowKey, C columnKey)	Adds or updates a value in the table 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

DefaultCategoryDataset

public DefaultCategoryDataset()

Creates a new (empty) dataset.

Method Detail

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

getValue

public Number getValue(int row,
                       int column)

Returns a value from the table.

Specified by:

getValue in interface Values2D

Parameters:

row - the row index (zero-based).

column - the column index (zero-based).

Returns:

The value (possibly null).

See Also:

addValue(Number, Comparable, Comparable), removeValue(Comparable, Comparable)

getRowKey

public R getRowKey(int row)

Returns the key for the specified row.

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(), getColumnKey(int)

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)

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:

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

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)

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:

getColumnKey(int)

getValue

public Number getValue(R rowKey,
                       C columnKey)

Returns the value for a pair of keys.

Specified by:

getValue in interface KeyedValues2D<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 value (possibly null).

Throws:

UnknownKeyException - if either key is not defined in the dataset.

See Also:

addValue(Number, Comparable, Comparable)

addValue

public void addValue(Number value,
                     R rowKey,
                     C columnKey)

Adds a value to the table. Performs the same function as setValue().

Parameters:

value - the value.

rowKey - the row key.

columnKey - the column key.

See Also:

getValue(Comparable, Comparable), removeValue(Comparable, Comparable)

addValue

public void addValue(double value,
                     R rowKey,
                     C columnKey)

Adds a value to the table.

Parameters:

value - the value.

rowKey - the row key.

columnKey - the column key.

See Also:

getValue(Comparable, Comparable)

setValue

public void setValue(Number value,
                     R rowKey,
                     C columnKey)

Adds or updates a value in the table and sends a DatasetChangeEvent to all registered listeners.

Parameters:

value - the value (null permitted).

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

See Also:

getValue(Comparable, Comparable)

setValue

public void setValue(double value,
                     R rowKey,
                     C columnKey)

Adds or updates a value in the table and sends a DatasetChangeEvent to all registered listeners.

Parameters:

value - the value.

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

See Also:

getValue(Comparable, Comparable)

incrementValue

public void incrementValue(double value,
                           R rowKey,
                           C columnKey)

Adds the specified value to an existing value in the dataset (if the existing value is null, it is treated as if it were 0.0).

Parameters:

value - the value.

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

Throws:

UnknownKeyException - if either key is not defined in the dataset.

removeValue

public void removeValue(R rowKey,
                        C columnKey)

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

Parameters:

rowKey - the row key.

columnKey - the column key.

See Also:

addValue(Number, 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.

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.

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.

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

Throws:

UnknownKeyException - if columnKey is not defined in the dataset.

See Also:

removeRow(Comparable)

clear

public void clear()

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

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

Returns a hash code for the dataset.

Overrides:

hashCode in class Object

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the dataset.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDataset

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning the dataset.