public class

MultipleXYSeriesLabelGenerator

extends Object
implements Serializable Cloneable XYSeriesLabelGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.MultipleXYSeriesLabelGenerator

Class Overview

A series label generator for plots that use data from an XYDataset.

Summary

Constants
String DEFAULT_LABEL_FORMAT The default item label format.
Public Constructors
MultipleXYSeriesLabelGenerator()
Creates an item label generator using default number formatters.
MultipleXYSeriesLabelGenerator(String format)
Creates a new series label generator.
Public Methods
void addSeriesLabel(int series, String label)
Adds an extra label for the specified series.
void clearSeriesLabels(int series)
Clears the extra labels for the specified series.
Object clone()
Returns an independent copy of the generator.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
String generateLabel(XYDataset dataset, int series)
Generates a label for the specified series.
int hashCode()
Returns a hash code for this instance.
Protected Methods
Object[] createItemArray(XYDataset dataset, int series)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.labels.XYSeriesLabelGenerator

Constants

public static final String DEFAULT_LABEL_FORMAT

The default item label format.

Constant Value: "{0}"

Public Constructors

public MultipleXYSeriesLabelGenerator ()

Creates an item label generator using default number formatters.

public MultipleXYSeriesLabelGenerator (String format)

Creates a new series label generator.

Parameters
format the format pattern (null not permitted).

Public Methods

public void addSeriesLabel (int series, String label)

Adds an extra label for the specified series.

Parameters
series the series index.
label the label.

public void clearSeriesLabels (int series)

Clears the extra labels for the specified series.

Parameters
series the series index.

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the other object (null permitted).
Returns
  • A boolean.

public String generateLabel (XYDataset dataset, int series)

Generates a label for the specified series. This label will be used for the chart legend.

Parameters
dataset the dataset (null not permitted).
series the series.
Returns
  • A series label.

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

Protected Methods

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).