Module platform
Package org.jfree.data

Class KeyToGroupMap

java.lang.Object
org.jfree.data.KeyToGroupMap
All Implemented Interfaces:
Serializable, Cloneable, PublicCloneable
public class KeyToGroupMap extends Object implements Cloneable, PublicCloneable, Serializable
A class that maps keys (instances of Comparable) to groups.
See Also:

  • Constructor Details

    • 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 Details

    • getGroupCount

      public int getGroupCount()
      Returns the number of groups in the map.
      Returns:
      The number of groups in 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).

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

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

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

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

    • equals

      public boolean equals(Object obj)
      Tests the map for equality against an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test against (null permitted).
      Returns:
      A boolean.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the map.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem cloning the map.