Module org.jfree.chart3d
Package org.jfree.chart3d.label

Class StandardXYZLabelGenerator

java.lang.Object
org.jfree.chart3d.label.StandardXYZLabelGenerator
All Implemented Interfaces:
Serializable, XYZLabelGenerator
public class StandardXYZLabelGenerator extends Object implements XYZLabelGenerator, Serializable
A default implementation of the XYZLabelGenerator interface. The implementation uses a Formatter instance to generate the labels, which are typically used as the series labels in the chart legend. Three values are passed to the formatter for possible inclusion in the resulting label: (1) the key for the series, (2) the count for the number of items in the series (as an Integer) and (3) the total of the non-NaN values in the series (as a Double).

NOTE: This class is serializable, but the serialization format is subject to change in future releases and should not be relied upon for persisting instances of this class.
Since:
1.2
See Also:

  • Field Details

  • Constructor Details

    • StandardXYZLabelGenerator

      public StandardXYZLabelGenerator()
      The default constructor.

    • StandardXYZLabelGenerator

      public StandardXYZLabelGenerator(String template)
      Creates a new instance with the specified label template.
      Parameters:
      template - the label template (null not permitted).

  • Method Details

    • generateSeriesLabel

      public <S extends Comparable<S>> String generateSeriesLabel(XYZDataset<S> dataset, S seriesKey)
      Generates a series label.
      Specified by:
      generateSeriesLabel in interface XYZLabelGenerator
      Type Parameters:
      S - The type of the series keys in the dataset.
      Parameters:
      dataset - the dataset (null not permitted).
      seriesKey - the series key (null not permitted).
      Returns:
      The series label (possibly null).

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object