org.jfree.chart.labels

Class MultipleXYSeriesLabelGenerator

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable, XYSeriesLabelGenerator

public class MultipleXYSeriesLabelGenerator
extends java.lang.Object
implements XYSeriesLabelGenerator, Cloneable, PublicCloneable, Serializable

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

Field Summary

static String
DEFAULT_LABEL_FORMAT
The default item label format.

Constructor Summary

MultipleXYSeriesLabelGenerator()
Creates an item label generator using default number formatters.
MultipleXYSeriesLabelGenerator(String format)
Creates a new series label generator.

Method Summary

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.
protected Object[]
createItemArray(XYDataset dataset, int series)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
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.

Field Details

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT
The default item label format.

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.

clone

public Object clone()
            throws CloneNotSupportedException
Returns an independent copy of the generator.
Returns:
A clone.

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

equals

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

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.