org.jfree.data
Class DefaultKeyedValues2D

java.lang.Object
  |
  +--org.jfree.data.DefaultKeyedValues2D

All Implemented Interfaces:

KeyedValues2D, java.io.Serializable, Values2D

public class DefaultKeyedValues2D

extends java.lang.Object

implements KeyedValues2D, java.io.Serializable

A data structure that stores zero, one or many values, where each value is associated with two keys (a 'row' key and a 'column' key).

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

DefaultKeyedValues2D()
Creates a new instance (initially empty).

Method Summary

void	addValue(java.lang.Number value, java.lang.Comparable rowKey, java.lang.Comparable columnKey) Adds a value to the table.
boolean	equals(java.lang.Object o) Tests if this object is equal to another.
int	getColumnCount() Returns the column count.
int	getColumnIndex(java.lang.Comparable key) Returns the column index for a given key.
java.lang.Comparable	getColumnKey(int column) Returns the key for a given column.
java.util.List	getColumnKeys() Returns the column keys.
int	getRowCount() Returns the row count.
int	getRowIndex(java.lang.Comparable key) Returns the row index for a given key.
java.lang.Comparable	getRowKey(int row) Returns the key for a given row.
java.util.List	getRowKeys() Returns the row keys.
java.lang.Number	getValue(java.lang.Comparable rowKey, java.lang.Comparable columnKey) Returns the value for the given row and column keys.
java.lang.Number	getValue(int row, int column) Returns the value for a given row and column.
void	removeColumn(java.lang.Comparable columnKey) Removes a column.
void	removeColumn(int columnIndex) Removes a column.
void	removeRow(java.lang.Comparable rowKey) Removes a row.
void	removeRow(int rowIndex) Removes a row.
void	removeValue(java.lang.Comparable rowKey, java.lang.Comparable columnKey) Removes a value.
void	setValue(java.lang.Number value, java.lang.Comparable rowKey, java.lang.Comparable columnKey) Adds or updates a value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultKeyedValues2D

public DefaultKeyedValues2D()

Creates a new instance (initially empty).

Method Detail

getRowCount

public int getRowCount()

Returns the row count.

Specified by:

getRowCount in interface Values2D

Returns:

the row count.

getColumnCount

public int getColumnCount()

Returns the column count.

Specified by:

getColumnCount in interface Values2D

Returns:

the column count.

getValue

public java.lang.Number getValue(int row,
                                 int column)

Returns the value for a given row and column.

Specified by:

getValue in interface Values2D

Parameters:

row - the row index.

column - the column index.

Returns:

the value.

getRowKey

public java.lang.Comparable getRowKey(int row)

Returns the key for a given row.

Specified by:

getRowKey in interface KeyedValues2D

Parameters:

row - the row index (zero based).

Returns:

the row index.

getRowIndex

public int getRowIndex(java.lang.Comparable key)

Returns the row index for a given key.

Specified by:

getRowIndex in interface KeyedValues2D

Parameters:

key - the key.

Returns:

the row index.

getRowKeys

public java.util.List getRowKeys()

Returns the row keys.

Specified by:

getRowKeys in interface KeyedValues2D

Returns:

the row keys.

getColumnKey

public java.lang.Comparable getColumnKey(int column)

Returns the key for a given column.

Specified by:

getColumnKey in interface KeyedValues2D

Parameters:

column - the column.

Returns:

the key.

getColumnIndex

public int getColumnIndex(java.lang.Comparable key)

Returns the column index for a given key.

Specified by:

getColumnIndex in interface KeyedValues2D

Parameters:

key - the key.

Returns:

the column index.

getColumnKeys

public java.util.List getColumnKeys()

Returns the column keys.

Specified by:

getColumnKeys in interface KeyedValues2D

Returns:

the column keys.

getValue

public java.lang.Number getValue(java.lang.Comparable rowKey,
                                 java.lang.Comparable columnKey)

Returns the value for the given row and column keys.

Specified by:

getValue in interface KeyedValues2D

Parameters:

rowKey - the row key.

columnKey - the column key.

Returns:

the value.

addValue

public void addValue(java.lang.Number value,
                     java.lang.Comparable rowKey,
                     java.lang.Comparable 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.

setValue

public void setValue(java.lang.Number value,
                     java.lang.Comparable rowKey,
                     java.lang.Comparable columnKey)

Adds or updates a value.

Parameters:

value - the value.

rowKey - the row key.

columnKey - the column key.

removeValue

public void removeValue(java.lang.Comparable rowKey,
                        java.lang.Comparable columnKey)

Removes a value.

Parameters:

rowKey - the row key.

columnKey - the column key.

removeRow

public void removeRow(int rowIndex)

Removes a row.

Parameters:

rowIndex - the row index.

removeRow

public void removeRow(java.lang.Comparable rowKey)

Removes a row.

Parameters:

rowKey - the row key.

removeColumn

public void removeColumn(int columnIndex)

Removes a column.

Parameters:

columnIndex - the column index.

removeColumn

public void removeColumn(java.lang.Comparable columnKey)

Removes a column.

Parameters:

columnKey - the column key.

equals

public boolean equals(java.lang.Object o)

Tests if this object is equal to another.

Overrides:

equals in class java.lang.Object

Parameters:

o - the other object.

Returns:

A boolean.