org.jfree.data
Class KeyedObjects

java.lang.Object
  |
  +--org.jfree.data.KeyedObjects

public class KeyedObjects

extends java.lang.Object

A collection of (key, object) pairs.

Author:

David Gilbert

Constructor Summary

KeyedObjects()
Creates a new collection (initially empty).

Method Summary

void	addObject(java.lang.Comparable key, java.lang.Object object) Adds a new object to the collection, or overwrites an existing object.
int	getIndex(java.lang.Comparable key) Returns the index for a given key.
int	getItemCount() Returns the number of items (values) in the collection.
java.lang.Comparable	getKey(int index) Returns a key.
java.util.List	getKeys() Returns the keys.
java.lang.Object	getObject(java.lang.Comparable key) Returns the object (possibly null) for a given key.
java.lang.Object	getObject(int item) Returns an object.
void	removeValue(java.lang.Comparable key) Removes a value from the collection.
void	removeValue(int index) Removes a value from the collection.
void	setObject(java.lang.Comparable key, java.lang.Object object) Replaces an existing object, or adds a new object to the collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyedObjects

public KeyedObjects()

Creates a new collection (initially empty).

Method Detail

getItemCount

public int getItemCount()

Returns the number of items (values) in the collection.

Returns:

the item count.

getObject

public java.lang.Object getObject(int item)

Returns an object.

Parameters:

item - the item index (zero-based).

Returns:

The object.

getKey

public java.lang.Comparable getKey(int index)

Returns a key.

Parameters:

index - the item index (zero-based).

Returns:

the row key.

getIndex

public int getIndex(java.lang.Comparable key)

Returns the index for a given key.

Parameters:

key - the key.

Returns:

the index.

getKeys

public java.util.List getKeys()

Returns the keys.

Returns:

the keys.

getObject

public java.lang.Object getObject(java.lang.Comparable key)

Returns the object (possibly null) for a given key.

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

Parameters:

key - the key.

Returns:

the object.

addObject

public void addObject(java.lang.Comparable key,
                      java.lang.Object object)

Adds a new object to the collection, or overwrites an existing object.

This is the same as the setObject(...) method.

Parameters:

key - the key.

object - the object.

setObject

public void setObject(java.lang.Comparable key,
                      java.lang.Object object)

Replaces an existing object, or adds a new object to the collection.

This is the same as the addObject(...) method.

Parameters:

key - the key.

object - the object.

removeValue

public void removeValue(int index)

Removes a value from the collection.

Parameters:

index - the index of the item to remove.

removeValue

public void removeValue(java.lang.Comparable key)

Removes a value from the collection.

Parameters:

key - the key of the item to remove.