Package org.jfree.data

Class KeyToGroupMap

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

  • 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

    • getGroups

      public List getGroups()
      Returns the groups (always including the default group) in the map.
      Returns:
      The groups.

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

    • getGroup

      public Comparable getGroup​(Comparable key)
      Returns the group that a key is mapped to.
      Parameters:
      key - the key.
      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, replaced by default group).

    • 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 org.jfree.util.PublicCloneable
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem cloning the map.