public class

DefaultKeyedValues2D

extends Object
implements Serializable Cloneable KeyedValues2D
java.lang.Object
   ↳ org.jfree.data.DefaultKeyedValues2D

Class Overview

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.

Summary

Public Constructors
DefaultKeyedValues2D()
Creates a new instance (initially empty).
DefaultKeyedValues2D(boolean sortRowKeys)
Creates a new instance (initially empty).
Public Methods
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 from the table.
void removeColumn(int columnIndex)
Removes a column.
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 to null.
void setValue(Number value, Comparable rowKey, Comparable columnKey)
Adds or updates a value.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.data.KeyedValues2D
From interface org.jfree.data.Values2D

Public Constructors

public DefaultKeyedValues2D ()

Creates a new instance (initially empty).

public DefaultKeyedValues2D (boolean sortRowKeys)

Creates a new instance (initially empty).

Parameters
sortRowKeys if the row keys should be sorted.

Public Methods

public void addValue (Number value, Comparable rowKey, Comparable columnKey)

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

public void clear ()

Clears all the data and associated keys.

public Object clone ()

Returns a clone.

Returns
  • A clone.
Throws
CloneNotSupportedException this class will not throw this exception, but subclasses (if any) might.

public boolean equals (Object o)

Tests if this object is equal to another.

Parameters
o the other object (null permitted).
Returns
  • A boolean.

public int getColumnCount ()

Returns the column count.

Returns
  • The column count.
See Also

public int getColumnIndex (Comparable key)

Returns the column index for a given key.

Parameters
key the key (null not permitted).
Returns
  • The column index.
See Also

public Comparable getColumnKey (int column)

Returns the key for a given column.

Parameters
column the column (in the range 0 to getColumnCount() - 1).
Returns
  • The key.
See Also

public List getColumnKeys ()

Returns the column keys in an unmodifiable list.

Returns
  • The column keys.
See Also

public int getRowCount ()

Returns the row count.

Returns
  • The row count.
See Also

public int getRowIndex (Comparable key)

Returns the row index for a given key.

Parameters
key the key (null not permitted).
Returns
  • The row index.
See Also

public Comparable getRowKey (int row)

Returns the key for a given row.

Parameters
row the row index (in the range 0 to getRowCount() - 1).
Returns
  • The row key.
See Also

public List getRowKeys ()

Returns the row keys in an unmodifiable list.

Returns
  • The row keys.
See Also

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.

Parameters
rowKey the row key (null not permitted).
columnKey the column key (null not permitted).
Returns
  • The value (possibly null).
See Also

public Number getValue (int row, int column)

Returns the value for a given row and column.

Parameters
row the row index.
column the column index.
Returns
  • The value.
See Also

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public void removeColumn (Comparable columnKey)

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 if columnKey is null.
See Also

public void removeColumn (int columnIndex)

Removes a column.

Parameters
columnIndex the column index.
See Also

public void removeRow (int rowIndex)

Removes a row.

Parameters
rowIndex the row index.
See Also

public void removeRow (Comparable rowKey)

Removes a row from the table.

Parameters
rowKey the row key (null not permitted).
Throws
UnknownKeyException if rowKey is not defined in the table.
See Also

public void removeValue (Comparable rowKey, Comparable columnKey)

Removes a value from the table by setting it to null. If all the values in the specified row and/or column are now null, 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

public void setValue (Number value, Comparable rowKey, Comparable columnKey)

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