Module platform
Package org.jfree.chart.labels

Class MultipleXYSeriesLabelGenerator

java.lang.Object
org.jfree.chart.labels.MultipleXYSeriesLabelGenerator
All Implemented Interfaces:
Serializable, Cloneable, XYSeriesLabelGenerator, PublicCloneable
public class MultipleXYSeriesLabelGenerator extends Object implements XYSeriesLabelGenerator, Cloneable, PublicCloneable, Serializable
A series label generator for plots that use data from an XYDataset.
See Also:

  • Field Details

    • DEFAULT_LABEL_FORMAT

      public static final String DEFAULT_LABEL_FORMAT
      The default item label format.
      See Also:

  • Constructor Details

    • MultipleXYSeriesLabelGenerator

      public MultipleXYSeriesLabelGenerator()
      Creates an item label generator using default number formatters.

    • MultipleXYSeriesLabelGenerator

      public MultipleXYSeriesLabelGenerator(String format)
      Creates a new series label generator.
      Parameters:
      format - the format pattern (null not permitted).

  • Method Details

    • addSeriesLabel

      public void addSeriesLabel(int series, String label)
      Adds an extra label for the specified series.
      Parameters:
      series - the series index.
      label - the label.

    • clearSeriesLabels

      public void clearSeriesLabels(int series)
      Clears the extra labels for the specified series.
      Parameters:
      series - the series index.

    • generateLabel

      public String generateLabel(XYDataset dataset, int series)
      Generates a label for the specified series. This label will be used for the chart legend.
      Specified by:
      generateLabel in interface XYSeriesLabelGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series.
      Returns:
      A series label.

    • createItemArray

      protected Object[] createItemArray(XYDataset dataset, int series)
      Creates the array of items that can be passed to the MessageFormat class for creating labels.
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series (zero-based index).
      Returns:
      The items (never null).

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns an independent copy of the generator.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if cloning is not supported.

    • equals

      public boolean equals(Object obj)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the other object (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.