Package org.jfree.data
Class DefaultKeyedValues2D
java.lang.Object
org.jfree.data.DefaultKeyedValues2D
- All Implemented Interfaces:
Serializable
,Cloneable
,PublicCloneable
,KeyedValues2D
,Values2D
public class DefaultKeyedValues2D extends 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.- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description DefaultKeyedValues2D()
Creates a new instance (initially empty).DefaultKeyedValues2D(boolean sortRowKeys)
Creates a new instance (initially empty). -
Method Summary
Modifier and Type Method Description 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(int row, int column)
Returns the value for a given row and column.Number
getValue(Comparable rowKey, Comparable columnKey)
Returns the value for the given row and column keys.int
hashCode()
Returns a hash code.void
removeColumn(int columnIndex)
Removes a column.void
removeColumn(Comparable columnKey)
Removes a column from the table.void
removeRow(int rowIndex)
Removes a row.void
removeRow(Comparable rowKey)
Removes a row from the table.void
removeValue(Comparable rowKey, Comparable columnKey)
Removes a value from the table by setting it tonull
.void
setValue(Number value, Comparable rowKey, Comparable columnKey)
Adds or updates a value.
-
Constructor Details
-
DefaultKeyedValues2D
public DefaultKeyedValues2D()Creates a new instance (initially empty). -
DefaultKeyedValues2D
Creates a new instance (initially empty).- Parameters:
sortRowKeys
- if the row keys should be sorted.
-
-
Method Details
-
getRowCount
Returns the row count.- Specified by:
getRowCount
in interfaceValues2D
- Returns:
- The row count.
- See Also:
getColumnCount()
-
getColumnCount
Returns the column count.- Specified by:
getColumnCount
in interfaceValues2D
- Returns:
- The column count.
- See Also:
getRowCount()
-
getValue
Returns the value for a given row and column.- Specified by:
getValue
in interfaceValues2D
- Parameters:
row
- the row index.column
- the column index.- Returns:
- The value.
- See Also:
getValue(Comparable, Comparable)
-
getRowKey
Returns the key for a given row.- Specified by:
getRowKey
in interfaceKeyedValues2D
- Parameters:
row
- the row index (in the range 0 togetRowCount()
- 1).- Returns:
- The row key.
- See Also:
getRowIndex(Comparable)
,getColumnKey(int)
-
getRowIndex
Returns the row index for a given key.- Specified by:
getRowIndex
in interfaceKeyedValues2D
- Parameters:
key
- the key (null
not permitted).- Returns:
- The row index.
- See Also:
getRowKey(int)
,getColumnIndex(Comparable)
-
getRowKeys
Returns the row keys in an unmodifiable list.- Specified by:
getRowKeys
in interfaceKeyedValues2D
- Returns:
- The row keys.
- See Also:
getColumnKeys()
-
getColumnKey
Returns the key for a given column.- Specified by:
getColumnKey
in interfaceKeyedValues2D
- Parameters:
column
- the column (in the range 0 togetColumnCount()
- 1).- Returns:
- The key.
- See Also:
getColumnIndex(Comparable)
,getRowKey(int)
-
getColumnIndex
Returns the column index for a given key.- Specified by:
getColumnIndex
in interfaceKeyedValues2D
- Parameters:
key
- the key (null
not permitted).- Returns:
- The column index.
- See Also:
getColumnKey(int)
,getRowIndex(Comparable)
-
getColumnKeys
Returns the column keys in an unmodifiable list.- Specified by:
getColumnKeys
in interfaceKeyedValues2D
- Returns:
- The column keys.
- See Also:
getRowKeys()
-
getValue
Returns the value for the given row and column keys. This method will throw anUnknownKeyException
if either key is not defined in the data structure.- Specified by:
getValue
in interfaceKeyedValues2D
- Parameters:
rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).- Returns:
- The value (possibly
null
). - See Also:
addValue(Number, Comparable, Comparable)
,removeValue(Comparable, Comparable)
-
addValue
Adds a value to the table. Performs the same function as #setValue(Number, Comparable, Comparable).- Parameters:
value
- the value (null
permitted).rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).- See Also:
setValue(Number, Comparable, Comparable)
,removeValue(Comparable, Comparable)
-
setValue
Adds or updates a value.- Parameters:
value
- the value (null
permitted).rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).- See Also:
addValue(Number, Comparable, Comparable)
,removeValue(Comparable, Comparable)
-
removeValue
Removes a value from the table by setting it tonull
. If all the values in the specified row and/or column are nownull
, the row and/or column is removed from the table.- Parameters:
rowKey
- the row key (null
not permitted).columnKey
- the column key (null
not permitted).- See Also:
addValue(Number, Comparable, Comparable)
-
removeRow
Removes a row.- Parameters:
rowIndex
- the row index.- See Also:
removeRow(Comparable)
,removeColumn(int)
-
removeRow
Removes a row from the table.- Parameters:
rowKey
- the row key (null
not permitted).- Throws:
UnknownKeyException
- ifrowKey
is not defined in the table.- See Also:
removeRow(int)
,removeColumn(Comparable)
-
removeColumn
Removes a column.- Parameters:
columnIndex
- the column index.- See Also:
removeColumn(Comparable)
,removeRow(int)
-
removeColumn
Removes a column from the table.- Parameters:
columnKey
- the column key (null
not permitted).- Throws:
UnknownKeyException
- if the table does not contain a column with the specified key.IllegalArgumentException
- ifcolumnKey
isnull
.- See Also:
removeColumn(int)
,removeRow(Comparable)
-
clear
Clears all the data and associated keys. -
equals
Tests if this object is equal to another. -
hashCode
Returns a hash code. -
clone
Returns a clone.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classObject
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- this class will not throw this exception, but subclasses (if any) might.
-