Module platform
Package org.jfree.data

Class KeyedObjects2D

java.lang.Object
org.jfree.data.KeyedObjects2D
All Implemented Interfaces:
Serializable, Cloneable
public class KeyedObjects2D extends Object implements Cloneable, Serializable
A data structure that stores zero, one or many objects, where each object is associated with two keys (a 'row' key and a 'column' key).
See Also:

  • Constructor Details

    • KeyedObjects2D

      public KeyedObjects2D()
      Creates a new instance (initially empty).

  • Method Details

    • getRowCount

      public int getRowCount()
      Returns the row count.
      Returns:
      The row count.
      See Also:

    • getColumnCount

      public int getColumnCount()
      Returns the column count.
      Returns:
      The column count.
      See Also:

    • getObject

      public Object getObject(int row, int column)
      Returns the object for a given row and column.
      Parameters:
      row - the row index (in the range 0 to getRowCount() - 1).
      column - the column index (in the range 0 to getColumnCount() - 1).
      Returns:
      The object (possibly null).
      See Also:

    • getRowKey

      public Comparable getRowKey(int row)
      Returns the key for a given row.
      Parameters:
      row - the row index (zero based).
      Returns:
      The row index.
      See Also:

    • getRowIndex

      public int getRowIndex(Comparable key)
      Returns the row index for a given key, or -1 if the key is not recognised.
      Parameters:
      key - the key (null not permitted).
      Returns:
      The row index.
      See Also:

    • getRowKeys

      public List getRowKeys()
      Returns the row keys.
      Returns:
      The row keys (never null).
      See Also:

    • getColumnKey

      public Comparable getColumnKey(int column)
      Returns the key for a given column.
      Parameters:
      column - the column.
      Returns:
      The key.
      See Also:

    • getColumnIndex

      public int getColumnIndex(Comparable key)
      Returns the column index for a given key, or -1 if the key is not recognised.
      Parameters:
      key - the key (null not permitted).
      Returns:
      The column index.
      See Also:

    • getColumnKeys

      public List getColumnKeys()
      Returns the column keys.
      Returns:
      The column keys (never null).
      See Also:

    • getObject

      public Object getObject(Comparable rowKey, Comparable columnKey)
      Returns the object for the given row and column keys.
      Parameters:
      rowKey - the row key (null not permitted).
      columnKey - the column key (null not permitted).
      Returns:
      The object (possibly null).
      Throws:
      IllegalArgumentException - if rowKey or columnKey is null.
      UnknownKeyException - if rowKey or columnKey is not recognised.

    • addObject

      public void addObject(Object object, Comparable rowKey, Comparable columnKey)
      Adds an object to the table. Performs the same function as setObject().
      Parameters:
      object - the object.
      rowKey - the row key (null not permitted).
      columnKey - the column key (null not permitted).

    • setObject

      public void setObject(Object object, Comparable rowKey, Comparable columnKey)
      Adds or updates an object.
      Parameters:
      object - the object.
      rowKey - the row key (null not permitted).
      columnKey - the column key (null not permitted).

    • removeObject

      public void removeObject(Comparable rowKey, Comparable columnKey)
      Removes an object from the table by setting it to null. If all the objects in the specified row and/or column are now null, the row and/or column is removed from the table.
      Parameters:
      rowKey - the row key (null not permitted).
      columnKey - the column key (null not permitted).
      See Also:

    • removeRow

      public void removeRow(int rowIndex)
      Removes an entire row from the table.
      Parameters:
      rowIndex - the row index.
      See Also:

    • removeRow

      public void removeRow(Comparable rowKey)
      Removes an entire row from the table.
      Parameters:
      rowKey - the row key (null not permitted).
      Throws:
      UnknownKeyException - if rowKey is not recognised.
      See Also:

    • removeColumn

      public void removeColumn(int columnIndex)
      Removes an entire column from the table.
      Parameters:
      columnIndex - the column index.
      See Also:

    • removeColumn

      public void removeColumn(Comparable columnKey)
      Removes an entire column from the table.
      Parameters:
      columnKey - the column key (null not permitted).
      Throws:
      UnknownKeyException - if rowKey is not recognised.
      See Also:

    • clear

      public void clear()
      Clears all the data and associated keys.

    • equals

      public boolean equals(Object obj)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test (null permitted).
      Returns:
      A boolean.

    • hashCode

      public int hashCode()
      Returns a hashcode for this object.
      Overrides:
      hashCode in class Object
      Returns:
      A hashcode.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone.
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - this class will not throw this exception, but subclasses (if any) might.