Package org.jfree.chart.labels
Class StandardXYSeriesLabelGenerator
- java.lang.Object
-
- org.jfree.chart.labels.StandardXYSeriesLabelGenerator
-
- All Implemented Interfaces:
Serializable
,Cloneable
,XYSeriesLabelGenerator
,org.jfree.util.PublicCloneable
public class StandardXYSeriesLabelGenerator extends Object implements XYSeriesLabelGenerator, Cloneable, org.jfree.util.PublicCloneable, Serializable
A standard series label generator for plots that use data from anXYDataset
.
This class implementsPublicCloneable
by mistake but we retain this for the sake of backward compatibility.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_LABEL_FORMAT
The default item label format.
-
Constructor Summary
Constructors Constructor Description StandardXYSeriesLabelGenerator()
Creates a default series label generator (usesDEFAULT_LABEL_FORMAT
).StandardXYSeriesLabelGenerator(String format)
Creates a new series label generator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 theMessageFormat
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.int
hashCode()
Returns a hash code for this instance.
-
-
-
Field Detail
-
DEFAULT_LABEL_FORMAT
public static final String DEFAULT_LABEL_FORMAT
The default item label format.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StandardXYSeriesLabelGenerator
public StandardXYSeriesLabelGenerator()
Creates a default series label generator (usesDEFAULT_LABEL_FORMAT
).
-
StandardXYSeriesLabelGenerator
public StandardXYSeriesLabelGenerator(String format)
Creates a new series label generator.- Parameters:
format
- the format pattern (null
not permitted).
-
-
Method Detail
-
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 interfaceXYSeriesLabelGenerator
- Parameters:
dataset
- the dataset (null
not permitted).series
- the series.- Returns:
- A series label.
-
createItemArray
protected Object[] createItemArray(XYDataset dataset, int series)
Creates the array of items that can be passed to theMessageFormat
class for creating labels.- Parameters:
dataset
- the dataset (null
not permitted).series
- the series (zero-based index).- Returns:
- The items (never
null
).
-
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.- Specified by:
clone
in interfaceorg.jfree.util.PublicCloneable
- Overrides:
clone
in classObject
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- if cloning is not supported.
-
equals
public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
-
-