Package org.jfree.data

Interface KeyedValues

All Superinterfaces:
Values
All Known Subinterfaces:
KeyedValuesDataset, PieDataset
All Known Implementing Classes:
CategoryToPieDataset, DefaultKeyedValues, DefaultKeyedValuesDataset, DefaultPieDataset, JDBCPieDataset
public interface KeyedValues
extends Values
A collection of values where each value is associated with a key.
See Also:
Values, DefaultKeyedValues

  • Method Summary

    Modifier and Type Method Description
    int getIndex​(Comparable key)
    Returns the index for a given key.
    Comparable getKey​(int index)
    Returns the key associated with an item (value).
    List getKeys()
    Returns the keys for the values in the collection.
    Number getValue​(Comparable key)
    Returns the value (possibly null) for a given key.

    Methods inherited from interface org.jfree.data.Values

    getItemCount, getValue

  • Method Details

    • getKey

      Comparable getKey​(int index)
      Returns the key associated with an item (value).
      Parameters:
      index - the item index (zero-based).
      Returns:
      the key.

    • getIndex

      int getIndex​(Comparable key)
      Returns the index for a given key.
      Parameters:
      key - the key.
      Returns:
      the index (-1 indicates that the key is not in the collection).

    • getKeys

      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.
      Returns:
      The keys (never null).

    • getValue

      Number getValue​(Comparable key)
      Returns the value (possibly null) for a given key.

      If the key is not recognised, the method should return null.

      Parameters:
      key - the key.
      Returns:
      the value.