Module org.jfree.chart
Package org.jfree.data

Class DefaultKeyedValues<K extends Comparable<K>>

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultKeyedValues()
      Creates a new collection (initially empty).

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addValue​(K key, double value)
      Updates an existing value, or adds a new value to the collection.
      void addValue​(K key, Number value)
      Adds a new value to the collection, or updates an existing value.
      void clear()
      Clears all values from the collection.
      Object clone()
      Returns a clone.
      boolean equals​(Object obj)
      Tests if this object is equal to another.
      int getIndex​(K key)
      Returns the index for a given key.
      int getItemCount()
      Returns the number of items (values) in the collection.
      K getKey​(int index)
      Returns a key.
      List<K> getKeys()
      Returns the keys for the values in the collection.
      Number getValue​(int item)
      Returns a value.
      Number getValue​(K key)
      Returns the value for a given key.
      int hashCode()
      Returns a hash code.
      void insertValue​(int position, K key, double value)
      Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.
      void insertValue​(int position, K key, Number value)
      Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.
      void removeValue​(int index)
      Removes a value from the collection.
      void removeValue​(K key)
      Removes a value from the collection.
      void setValue​(K key, double value)
      Updates an existing value, or adds a new value to the collection.
      void setValue​(K key, Number value)
      Updates an existing value, or adds a new value to the collection.
      void sortByKeys​(SortOrder order)
      Sorts the items in the list by key.
      void sortByValues​(SortOrder order)
      Sorts the items in the list by value.

    • Constructor Detail

      • DefaultKeyedValues

        public DefaultKeyedValues()
        Creates a new collection (initially empty).

    • Method Detail

      • getItemCount

        public int getItemCount()
        Returns the number of items (values) in the collection.
        Specified by:
        getItemCount in interface Values
        Returns:
        The item count.

      • getValue

        public Number getValue​(int item)
        Returns a value.
        Specified by:
        getValue in interface Values
        Parameters:
        item - the item of interest (zero-based index).
        Returns:
        The value (possibly null).
        Throws:
        IndexOutOfBoundsException - if item is out of bounds.

      • addValue

        public void addValue​(K key,
                     double value)
        Updates an existing value, or adds a new value to the collection.
        Parameters:
        key - the key (null not permitted).
        value - the value.
        See Also:
        addValue(Comparable, Number)

      • addValue

        public void addValue​(K key,
                     Number value)
        Adds a new value to the collection, or updates an existing value. This method passes control directly to the setValue(Comparable, Number) method.
        Parameters:
        key - the key (null not permitted).
        value - the value (null permitted).

      • setValue

        public void setValue​(K key,
                     double value)
        Updates an existing value, or adds a new value to the collection.
        Parameters:
        key - the key (null not permitted).
        value - the value.

      • setValue

        public void setValue​(K key,
                     Number value)
        Updates an existing value, or adds a new value to the collection.
        Parameters:
        key - the key (null not permitted).
        value - the value (null permitted).

      • insertValue

        public void insertValue​(int position,
                        K key,
                        double value)
        Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.
        Parameters:
        position - the position (in the range 0 to getItemCount()).
        key - the key (null not permitted).
        value - the value.
        Since:
        1.0.6

      • insertValue

        public void insertValue​(int position,
                        K key,
                        Number value)
        Inserts a new value at the specified position in the dataset or, if there is an existing item with the specified key, updates the value for that item and moves it to the specified position.
        Parameters:
        position - the position (in the range 0 to getItemCount()).
        key - the key (null not permitted).
        value - the value (null permitted).
        Since:
        1.0.6

      • removeValue

        public void removeValue​(int index)
        Removes a value from the collection.
        Parameters:
        index - the index of the item to remove (in the range 0 to getItemCount() -1).
        Throws:
        IndexOutOfBoundsException - if index is not within the specified range.

      • clear

        public void clear()
        Clears all values from the collection.
        Since:
        1.0.2

      • sortByKeys

        public void sortByKeys​(SortOrder order)
        Sorts the items in the list by key.
        Parameters:
        order - the sort order (null not permitted).

      • sortByValues

        public void sortByValues​(SortOrder order)
        Sorts the items in the list by value. If the list contains null values, they will sort to the end of the list, irrespective of the sort order.
        Parameters:
        order - the sort order (null not permitted).

      • equals

        public boolean equals​(Object obj)
        Tests if this object is equal to another.
        Overrides:
        equals in class Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Returns a hash code.
        Overrides:
        hashCode in class Object
        Returns:
        A hash code.