public interface

KeyedValues2D

implements Values2D
org.jfree.data.KeyedValues2D
Known Indirect Subclasses

Class Overview

An extension of the Values2D interface where a unique key is associated with the row and column indices.

Summary

Public Methods
abstract int getColumnIndex(Comparable key)
Returns the column index for a given key.
abstract Comparable getColumnKey(int column)
Returns the column key for a given index.
abstract List getColumnKeys()
Returns the column keys.
abstract int getRowIndex(Comparable key)
Returns the row index for a given key.
abstract Comparable getRowKey(int row)
Returns the row key for a given index.
abstract List getRowKeys()
Returns the row keys.
abstract Number getValue(Comparable rowKey, Comparable columnKey)
Returns the value associated with the specified keys.
[Expand]
Inherited Methods
From interface org.jfree.data.Values2D

Public Methods

public abstract int getColumnIndex (Comparable key)

Returns the column index for a given key.

Parameters
key the column key.
Returns
  • The column index, or -1 if the key is unrecognised.

public abstract Comparable getColumnKey (int column)

Returns the column key for a given index.

Parameters
column the column index (zero-based).
Returns
  • The column key.
Throws
IndexOutOfBoundsException if row is out of bounds.

public abstract List getColumnKeys ()

Returns the column keys.

Returns
  • The keys.

public abstract int getRowIndex (Comparable key)

Returns the row index for a given key.

Parameters
key the row key.
Returns
  • The row index, or -1 if the key is unrecognised.

public abstract Comparable getRowKey (int row)

Returns the row key for a given index.

Parameters
row the row index (zero-based).
Returns
  • The row key.
Throws
IndexOutOfBoundsException if row is out of bounds.

public abstract List getRowKeys ()

Returns the row keys.

Returns
  • The keys.

public abstract Number getValue (Comparable rowKey, Comparable columnKey)

Returns the value associated with the specified keys.

Parameters
rowKey the row key (null not permitted).
columnKey the column key (null not permitted).
Returns
  • The value.
Throws
UnknownKeyException if either key is not recognised.