org.jfree.data
Interface KeyedValues

All Superinterfaces:
Values
All Known Subinterfaces:
KeyedValuesDataset, PieDataset
All Known Implementing Classes:
CategoryToPieDataset, DefaultKeyedValues, DefaultKeyedValuesDataset, DefaultPieDataset

public interface KeyedValues
extends Values

An ordered list of (key, value) items.

See Also:
Values, DefaultKeyedValues

Method Summary
 int getIndex(java.lang.Comparable key)
          Returns the index for a given key.
 java.lang.Comparable getKey(int index)
          Returns the key associated with an item (value).
 java.util.List getKeys()
          Returns the keys for the values in the collection.
 java.lang.Number getValue(java.lang.Comparable key)
          Returns the value for a given key.
 
Methods inherited from interface org.jfree.data.Values
getItemCount, getValue
 

Method Detail

getKey

public java.lang.Comparable getKey(int index)
Returns the key associated with an item (value).

Parameters:
index - the item index (zero-based).
Returns:
The key.
Throws:
java.lang.IndexOutOfBoundsException - if index is out of bounds.

getIndex

public int getIndex(java.lang.Comparable key)
Returns the index for a given key.

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

getKeys

public java.util.List getKeys()
Returns the keys for the values in the collection. Note that you can access the values in this collection by key or by index. For this reason, the key order is important - this method should return the keys in order. The returned list may be unmodifiable.

Returns:
The keys (never null).

getValue

public java.lang.Number getValue(java.lang.Comparable key)
Returns the value for a given key.

Parameters:
key - the key.
Returns:
The value (possibly null).
Throws:
UnknownKeyException - if the key is not recognised.