org.jfree.data

Class KeyedObjects2D

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).

Constructor Summary
	KeyedObjects2D() Creates a new instance (initially empty).

Method Summary
void	addObject(Object object, Comparable rowKey, Comparable columnKey) Adds an object to the table.
void	clear() Clears all the data and associated keys.
Object	clone() Returns a clone.
boolean	equals(Object obj) Tests this object for equality with an arbitrary object.
int	getColumnCount() Returns the column count.
int	getColumnIndex(Comparable key) Returns the column index for a given key, or `-1` if the key is not recognised.
Comparable	getColumnKey(int column) Returns the key for a given column.
List	getColumnKeys() Returns the column keys.
Object	getObject(int row, int column) Returns the object for a given row and column.
Object	getObject(Comparable rowKey, Comparable columnKey) Returns the object for the given row and column keys.
int	getRowCount() Returns the row count.
int	getRowIndex(Comparable key) Returns the row index for a given key, or `-1` if the key is not recognised.
Comparable	getRowKey(int row) Returns the key for a given row.
List	getRowKeys() Returns the row keys.
int	hashCode() Returns a hashcode for this object.
void	removeColumn(int columnIndex) Removes an entire column from the table.
void	removeColumn(Comparable columnKey) Removes an entire column from the table.
void	removeObject(Comparable rowKey, Comparable columnKey) Removes an object from the table by setting it to `null`.
void	removeRow(int rowIndex) Removes an entire row from the table.
void	removeRow(Comparable rowKey) Removes an entire row from the table.
void	setObject(Object object, Comparable rowKey, Comparable columnKey) Adds or updates an object.

Constructor Detail

KeyedObjects2D

public KeyedObjects2D()

Creates a new instance (initially empty).

Method Detail

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).

clear

public void clear()

Clears all the data and associated keys.

Since: 1.0.7

clone

public Object clone()

Returns a clone.

Returns: A clone.

Throws: CloneNotSupportedException this class will not throw this exception, but subclasses (if any) might.

equals

public boolean equals(Object obj)

Tests this object for equality with an arbitrary object.

Parameters: obj the object to test (null permitted).

Returns: A boolean.

getColumnCount

public int getColumnCount()

Returns the column count.

Returns: The column count.

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.

getColumnKey

public Comparable getColumnKey(int column)

Returns the key for a given column.

Parameters: column the column.

Returns: The key.

getColumnKeys

public List getColumnKeys()

Returns the column keys.

Returns: The column keys (never null).

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).

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.




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



   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: KeyedObjects2D 



   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 



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



   hashCode
   public  int hashCode()
   
 Returns a hashcode for this object.
Returns: A hashcode. 



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



   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: removeRow 



   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: KeyedObjects2D 



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



   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 



   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). 


   
   
    
      Overview
      Package
      Class
      Use
      Tree
      Deprecated
      Index
      Help
    
    
      
       Prev Class
       Next Class
      
      
       Frames
       NoFrames
      
      All Classes
   
   
      Summary:
       Nested
       Field
       Constr
       Method
      
      Detail:
       Field
       Constr
       Method
      
   
    
     Footer
And More
    
    
   
   Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.

HeaderAnd More

Class KeyedObjects2D

FooterAnd More

Header
And More

Footer
And More