org.jfree.data

Class KeyToGroupMap

public class KeyToGroupMap extends Object implements Cloneable, PublicCloneable, Serializable

A class that maps keys (instances of Comparable) to groups.
Constructor Summary
KeyToGroupMap()
Creates a new map with a default group named 'Default Group'.
KeyToGroupMap(Comparable defaultGroup)
Creates a new map with the specified default group.
Method Summary
Objectclone()
Returns a clone of the map.
booleanequals(Object obj)
Tests the map for equality against an arbitrary object.
ComparablegetGroup(Comparable key)
Returns the group that a key is mapped to.
intgetGroupCount()
Returns the number of groups in the map.
intgetGroupIndex(Comparable group)
Returns the index for the group.
ListgetGroups()
Returns a list of the groups (always including the default group) in the map.
intgetKeyCount(Comparable group)
Returns the number of keys mapped to the specified group.
voidmapKeyToGroup(Comparable key, Comparable group)
Maps a key to a group.

Constructor Detail

KeyToGroupMap

public KeyToGroupMap()
Creates a new map with a default group named 'Default Group'.

KeyToGroupMap

public KeyToGroupMap(Comparable defaultGroup)
Creates a new map with the specified default group.

Parameters: defaultGroup the default group (null not permitted).

Method Detail

clone

public Object clone()
Returns a clone of the map.

Returns: A clone.

Throws: CloneNotSupportedException if there is a problem cloning the map.

equals

public boolean equals(Object obj)
Tests the map for equality against an arbitrary object.

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

Returns: A boolean.

getGroup

public Comparable getGroup(Comparable key)
Returns the group that a key is mapped to.

Parameters: key the key (null not permitted).

Returns: The group (never null, returns the default group if there is no mapping for the specified key).

getGroupCount

public int getGroupCount()
Returns the number of groups in the map.

Returns: The number of groups in the map.

getGroupIndex

public int getGroupIndex(Comparable group)
Returns the index for the group.

Parameters: group the group.

Returns: The group index (or -1 if the group is not represented within the map).

getGroups

public List getGroups()
Returns a list of the groups (always including the default group) in the map. The returned list is independent of the map, so altering the list will have no effect.

Returns: The groups (never null).

getKeyCount

public int getKeyCount(Comparable group)
Returns the number of keys mapped to the specified group. This method won't always return an accurate result for the default group, since explicit mappings are not required for this group.

Parameters: group the group (null not permitted).

Returns: The key count.

mapKeyToGroup

public void mapKeyToGroup(Comparable key, Comparable group)
Maps a key to a group.

Parameters: key the key (null not permitted). group the group (null permitted, clears any existing mapping).