Package org.jfree.chart.labels
Class MultipleXYSeriesLabelGenerator
- java.lang.Object
-
- org.jfree.chart.labels.MultipleXYSeriesLabelGenerator
-
- All Implemented Interfaces:
Serializable
,Cloneable
,XYSeriesLabelGenerator
,org.jfree.util.PublicCloneable
public class MultipleXYSeriesLabelGenerator extends Object implements XYSeriesLabelGenerator, Cloneable, org.jfree.util.PublicCloneable, Serializable
A series label generator for plots that use data from anXYDataset
.- 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 MultipleXYSeriesLabelGenerator()
Creates an item label generator using default number formatters.MultipleXYSeriesLabelGenerator(String format)
Creates a new series label generator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 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
-
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 Detail
-
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.
-
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.- 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.
-
-