Package org.jfree.chart.labels
Class MultipleXYSeriesLabelGenerator
- java.lang.Object
-
- org.jfree.chart.labels.MultipleXYSeriesLabelGenerator
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,XYSeriesLabelGenerator
,PublicCloneable
public class MultipleXYSeriesLabelGenerator extends java.lang.Object implements XYSeriesLabelGenerator, java.lang.Cloneable, PublicCloneable, java.io.Serializable
A series label generator for plots that use data from anXYDataset
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
additionalFormatPattern
The format pattern for additional labels.static java.lang.String
DEFAULT_LABEL_FORMAT
The default item label format.private java.lang.String
formatPattern
The format pattern for the initial part of the label.private static long
serialVersionUID
For serialization.private java.util.Map
seriesLabelLists
Storage for the additional series labels.
-
Constructor Summary
Constructors Constructor Description MultipleXYSeriesLabelGenerator()
Creates an item label generator using default number formatters.MultipleXYSeriesLabelGenerator(java.lang.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, java.lang.String label)
Adds an extra label for the specified series.void
clearSeriesLabels(int series)
Clears the extra labels for the specified series.java.lang.Object
clone()
Returns an independent copy of the generator.protected java.lang.Object[]
createItemArray(XYDataset dataset, int series)
Creates the array of items that can be passed to theMessageFormat
class for creating labels.boolean
equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.java.lang.String
generateLabel(XYDataset dataset, int series)
Generates a label for the specified series.int
hashCode()
Returns a hash code for this instance.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
DEFAULT_LABEL_FORMAT
public static final java.lang.String DEFAULT_LABEL_FORMAT
The default item label format.- See Also:
- Constant Field Values
-
formatPattern
private java.lang.String formatPattern
The format pattern for the initial part of the label.
-
additionalFormatPattern
private java.lang.String additionalFormatPattern
The format pattern for additional labels.
-
seriesLabelLists
private java.util.Map seriesLabelLists
Storage for the additional series labels.
-
-
Constructor Detail
-
MultipleXYSeriesLabelGenerator
public MultipleXYSeriesLabelGenerator()
Creates an item label generator using default number formatters.
-
MultipleXYSeriesLabelGenerator
public MultipleXYSeriesLabelGenerator(java.lang.String format)
Creates a new series label generator.- Parameters:
format
- the format pattern (null
not permitted).
-
-
Method Detail
-
addSeriesLabel
public void addSeriesLabel(int series, java.lang.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 java.lang.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 java.lang.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 java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns an independent copy of the generator.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classjava.lang.Object
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if cloning is not supported.
-
equals
public boolean equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the other object (null
permitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- A hash code.
-
-