org.jfree.chart.labels

Class StandardXYSeriesLabelGenerator

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.
Field Summary
static StringDEFAULT_LABEL_FORMAT
The default item label format.
Constructor Summary
StandardXYSeriesLabelGenerator()
Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).
StandardXYSeriesLabelGenerator(String format)
Creates a new series label generator.
Method Summary
Objectclone()
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.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
StringgenerateLabel(XYDataset dataset, int series)
Generates a label for the specified series.

Field Detail

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT
The default item label format.

Constructor Detail

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 Detail

clone

public Object clone()
Returns an independent copy of the generator. This is unnecessary, because instances are immutable anyway, but we retain this behaviour for backwards compatibility.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not supported.

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.

Parameters: dataset the dataset (null not permitted). series the series.

Returns: A series label.