Module platform
Package org.jfree.chart.labels

Class AbstractPieItemLabelGenerator

java.lang.Object
org.jfree.chart.labels.AbstractPieItemLabelGenerator
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
StandardPieSectionLabelGenerator, StandardPieToolTipGenerator
public class AbstractPieItemLabelGenerator extends Object implements Serializable
A base class used for generating pie chart item labels.
See Also:

  • Constructor Details

    • AbstractPieItemLabelGenerator

      protected AbstractPieItemLabelGenerator(String labelFormat, NumberFormat numberFormat, NumberFormat percentFormat)
      Creates an item label generator using the specified number formatters.
      Parameters:
      labelFormat - the label format string (null not permitted).
      numberFormat - the format object for the values (null not permitted).
      percentFormat - the format object for the percentages (null not permitted).

  • Method Details

    • getLabelFormat

      public String getLabelFormat()
      Returns the label format string.
      Returns:
      The label format string (never null).

    • getNumberFormat

      public NumberFormat getNumberFormat()
      Returns the number formatter.
      Returns:
      The formatter (never null).

    • getPercentFormat

      public NumberFormat getPercentFormat()
      Returns the percent formatter.
      Returns:
      The formatter (never null).

    • createItemArray

      protected Object[] createItemArray(PieDataset dataset, Comparable key)
      Creates the array of items that can be passed to the MessageFormat class for creating labels. The returned array contains four values:
      • result[0] = the section key converted to a String;
      • result[1] = the formatted data value;
      • result[2] = the formatted percentage (of the total);
      • result[3] = the formatted total value.
      Parameters:
      dataset - the dataset (null not permitted).
      key - the key (null not permitted).
      Returns:
      The items (never null).

    • generateSectionLabel

      protected String generateSectionLabel(PieDataset dataset, Comparable key)
      Generates a label for a pie section.
      Parameters:
      dataset - the dataset (null not permitted).
      key - the section key (null not permitted).
      Returns:
      The label (possibly null).

    • equals

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

    • hashCode

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns an independent copy of the generator.
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - should not happen.