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.
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.
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.
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 a column.
void	removeColumn(Comparable columnKey) Removes a column.
void	removeObject(Comparable rowKey, Comparable columnKey) Removes an object.
void	removeRow(int rowIndex) Removes a row.
void	removeRow(Comparable rowKey) Removes a row.
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. columnKey the column key.

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.

Parameters: key the key.

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. column the column index.

Returns: The object.

getObject

public Object getObject(Comparable rowKey, Comparable columnKey)

Returns the object for the given row and column keys.

Parameters: rowKey the row key. columnKey the column key.

Returns: The object.

getRowCount

public int getRowCount()

Returns the row count.

Returns: The row count.

getRowIndex

public int getRowIndex(Comparable key)

Returns the row index for a given key.

Parameters: key the key.

Returns: The row index.

getRowKey

public Comparable getRowKey(int row)

Returns the key for a given row.

Parameters: row the row index (zero based).

Returns: The row index.

getRowKeys

public List getRowKeys()

Returns the row keys.

Returns: The row keys (never null).

hashCode

public int hashCode()

Returns a hashcode for this object.

Returns: A hashcode.

removeColumn

public void removeColumn(int columnIndex)

Removes a column.

Parameters: columnIndex the column index.

removeColumn

public void removeColumn(Comparable columnKey)

Removes a column.

Parameters: columnKey the column key.

removeObject

public void removeObject(Comparable rowKey, Comparable columnKey)

Removes an object.

Parameters: rowKey the row key. columnKey the column key.

removeRow

public void removeRow(int rowIndex)

Removes a row.

Parameters: rowIndex the row index.

removeRow

public void removeRow(Comparable rowKey)

Removes a row.

Parameters: rowKey the row key.

setObject

public void setObject(Object object, Comparable rowKey, Comparable columnKey)

Adds or updates an object.

Parameters: object the object. rowKey the row key. columnKey the column key.