org.jfree.data
Class DefaultKeyedValues2D
java.lang.Object
org.jfree.data.DefaultKeyedValues2D
- Cloneable, KeyedValues2D, PublicCloneable, Serializable, Values2D
extends java.lang.Object
implements KeyedValues2D, PublicCloneable, Cloneable, 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). The keys
should be (a) instances of Comparable
and (b) immutable.
void | addValue(Number value, Comparable rowKey, Comparable columnKey) - Adds a value to the table.
|
void | clear() - Clears all the data and associated keys.
|
Object | clone() - Returns a clone.
|
boolean | equals(Object o) - Tests if this object is equal to another.
|
int | getColumnCount() - Returns the column count.
|
int | getColumnIndex(Comparable key) - Returns the column index for a given key.
|
Comparable | getColumnKey(int column) - Returns the key for a given column.
|
List | getColumnKeys() - Returns the column keys in an unmodifiable list.
|
int | getRowCount() - Returns the row count.
|
int | getRowIndex(Comparable key) - Returns the row index for a given key.
|
Comparable | getRowKey(int row) - Returns the key for a given row.
|
List | getRowKeys() - Returns the row keys in an unmodifiable list.
|
Number | getValue(Comparable rowKey, Comparable columnKey) - Returns the value for the given row and column keys.
|
Number | getValue(int row, int column) - Returns the value for a given row and column.
|
int | hashCode() - Returns a hash code.
|
void | removeColumn(Comparable columnKey) - Removes a column.
|
void | removeColumn(int columnIndex) - Removes a column.
|
void | removeRow(Comparable rowKey) - Removes a row.
|
void | removeRow(int rowIndex) - Removes a row.
|
void | removeValue(Comparable rowKey, Comparable columnKey) - Removes a value.
|
void | setValue(Number value, Comparable rowKey, Comparable columnKey) - Adds or updates a value.
|
DefaultKeyedValues2D
public DefaultKeyedValues2D(boolean sortRowKeys)
Creates a new instance (initially empty).
sortRowKeys
- if the row keys should be sorted.
addValue
public void addValue(Number value,
Comparable rowKey,
Comparable columnKey)
Adds a value to the table. Performs the same function as
#setValue(Number, Comparable, Comparable).
value
- the value (null
permitted).rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).
clear
public void clear()
Clears all the data and associated keys.
clone
public Object clone()
throws CloneNotSupportedException
Returns a clone.
equals
public boolean equals(Object o)
Tests if this object is equal to another.
o
- the other object (null
permitted).
getValue
public Number getValue(Comparable rowKey,
Comparable columnKey)
Returns the value for the given row and column keys. This method will
throw an
UnknownKeyException
if either key is not defined in the
data structure.
- getValue in interface KeyedValues2D
rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).
- The value (possibly
null
).
getValue
public Number getValue(int row,
int column)
Returns the value for a given row and column.
- getValue in interface Values2D
row
- the row index.column
- the column index.
hashCode
public int hashCode()
Returns a hash code.
removeColumn
public void removeColumn(Comparable columnKey)
Removes a column.
columnKey
- the column key (null
not permitted).
removeColumn
public void removeColumn(int columnIndex)
Removes a column.
columnIndex
- the column index.
removeRow
public void removeRow(Comparable rowKey)
Removes a row.
rowKey
- the row key (null
not permitted).
removeRow
public void removeRow(int rowIndex)
Removes a row.
rowIndex
- the row index.
removeValue
public void removeValue(Comparable rowKey,
Comparable columnKey)
Removes a value.
rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).
setValue
public void setValue(Number value,
Comparable rowKey,
Comparable columnKey)
Adds or updates a value.
value
- the value (null
permitted).rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).