Module platform
Package org.jfree.data

Interface KeyedValues2D

All Superinterfaces:
Values2D
All Known Subinterfaces:
BoxAndWhiskerCategoryDataset, CategoryDataset, GanttCategoryDataset, IntervalCategoryDataset, KeyedValues2DDataset, MultiValueCategoryDataset, StatisticalCategoryDataset
All Known Implementing Classes:
DatasetAdapter, DefaultBoxAndWhiskerCategoryDataset, DefaultCategoryDataset, DefaultIntervalCategoryDataset, DefaultKeyedValues2D, DefaultKeyedValues2DDataset, DefaultMultiValueCategoryDataset, DefaultStatisticalCategoryDataset, SlidingCategoryDataset, SlidingGanttCategoryDataset, StatisticsAdapter, TaskSeriesCollection
public interface KeyedValues2D extends Values2D
An extension of the Values2D interface where a unique key is associated with the row and column indices.

  • Method Details

    • getRowKey

      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.

    • getRowIndex

      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.

    • getRowKeys

      List getRowKeys()
      Returns the row keys.
      Returns:
      The keys.

    • getColumnKey

      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.

    • getColumnIndex

      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.

    • getColumnKeys

      List getColumnKeys()
      Returns the column keys.
      Returns:
      The keys.

    • getValue

      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.