Module platform
Package org.jfree.chart.labels

Class StandardXYSeriesLabelGenerator

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

This class implements PublicCloneable by mistake but we retain this for the sake of backward compatibility.
See Also:

  • Field Details

    • DEFAULT_LABEL_FORMAT

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

  • Constructor Details

    • StandardXYSeriesLabelGenerator

      public StandardXYSeriesLabelGenerator()
      Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).

    • StandardXYSeriesLabelGenerator

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

  • Method Details

    • 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. This is unnecessary, because instances are immutable anyway, but we retain this behaviour for backwards compatibility.
      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.