org.jfree.data

Interface KeyedValues2D

public interface KeyedValues2D extends Values2D

An extension of the Values2D interface where a unique key is associated with the row and column indices.
Method Summary
intgetColumnIndex(Comparable key)
Returns the column index for a given key.
ComparablegetColumnKey(int column)
Returns the column key for a given index.
ListgetColumnKeys()
Returns the column keys.
intgetRowIndex(Comparable key)
Returns the row index for a given key.
ComparablegetRowKey(int row)
Returns the row key for a given index.
ListgetRowKeys()
Returns the row keys.
NumbergetValue(Comparable rowKey, Comparable columnKey)
Returns the value associated with the specified keys.

Method Detail

getColumnIndex

public 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.

getColumnKey

public 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.

getColumnKeys

public List getColumnKeys()
Returns the column keys.

Returns: The keys.

getRowIndex

public 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.

getRowKey

public 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.

getRowKeys

public List getRowKeys()
Returns the row keys.

Returns: The keys.

getValue

public 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.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.