Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.labels

Class StandardXYSeriesLabelGenerator

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable, XYSeriesLabelGenerator
public class StandardXYSeriesLabelGenerator
extends java.lang.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 String
DEFAULT_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

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

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

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

Overview Package Class Use Source Tree Index Deprecated About