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

This class implements PublicCloneable by mistake but we retain this for the sake of backward compatibility.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_LABEL_FORMAT
The default item label format.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LABEL_FORMAT` The default item label format.

Constructor Summary

Constructors
Constructor and Description
`StandardXYSeriesLabelGenerator()` Creates a default series label generator (uses `DEFAULT_LABEL_FORMAT`).
`StandardXYSeriesLabelGenerator(String format)` Creates a new series label generator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns an independent copy of the generator.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- 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 (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
  - 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.
  - 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 interface org.jfree.util.PublicCloneable
    
    Overrides:
    
    clone in class Object
    
    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.
    
    Overrides:
    
    equals in class 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 class Object
    
    Returns:
    
    A hash code.

Class StandardXYSeriesLabelGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LABEL_FORMAT

Constructor Detail

StandardXYSeriesLabelGenerator

StandardXYSeriesLabelGenerator

Method Detail

generateLabel

clone

equals

hashCode