Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data

Interface KeyedValues

All Superinterfaces:
Values
Known Subinterfaces:
KeyedValuesDataset, PieDataset
Known Implementing Classes:
CategoryToPieDataset, DefaultKeyedValues, DefaultKeyedValuesDataset, DefaultPieDataset, JDBCPieDataset
public interface KeyedValues
extends Values
An ordered list of (key, value) items where the keys are unique and non-null.
See Also:
Values, DefaultKeyedValues

Method Summary

int
getIndex(Comparable key)
Returns the index for a given key.
Comparable
getKey(int index)
Returns the key associated with the item at a given position.
List
getKeys()
Returns the keys for the values in the collection.
Number
getValue(Comparable key)
Returns the value for a given key.

Methods inherited from interface org.jfree.data.Values

getItemCount, getValue

Method Details

getIndex

public int getIndex(Comparable key)
Returns the index for a given key.
Parameters:
key - the key (null not permitted).
Returns:
The index, or -1 if the key is unrecognised.

getKey

public Comparable getKey(int index)
Returns the key associated with the item at a given position. Note that some implementations allow re-ordering of the data items, so the result may be transient.
Parameters:
index - the item index (in the range 0 to getItemCount() - 1).
Returns:
The key (never null).

getKeys

public 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 Number getValue(Comparable key)
Returns the value for a given key.
Parameters:
key - the key.
Returns:
The value (possibly null).

Overview Package Class Use Source Tree Index Deprecated About