org.jfree.data
public class KeyToGroupMap extends Object implements Cloneable, PublicCloneable, Serializable
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 | |
---|---|
Object | clone()
Returns a clone of the map.
|
boolean | equals(Object obj)
Tests the map for equality against an arbitrary object.
|
Comparable | getGroup(Comparable key)
Returns the group that a key is mapped to.
|
int | getGroupCount()
Returns the number of groups in the map.
|
int | getGroupIndex(Comparable group)
Returns the index for the group.
|
List | getGroups()
Returns a list of the groups (always including the default group) in the
map. |
int | getKeyCount(Comparable group)
Returns the number of keys mapped to the specified group. |
void | mapKeyToGroup(Comparable key, Comparable group)
Maps a key to a group.
|
Parameters: defaultGroup the default group (null
not permitted).
Returns: A clone.
Throws: CloneNotSupportedException if there is a problem cloning the map.
Parameters: obj the object to test against (null
permitted).
Returns: A boolean.
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).
Returns: The number of groups in the map.
Parameters: group the group.
Returns: The group index (or -1 if the group is not represented within the map).
Returns: The groups (never null
).
Parameters: group the group (null
not permitted).
Returns: The key count.
Parameters: key the key (null
not permitted). group the group (null
permitted, clears any
existing mapping).