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 StandardCategorySeriesLabelGenerator

Implemented Interfaces:
CategorySeriesLabelGenerator, Cloneable, PublicCloneable, Serializable
public class StandardCategorySeriesLabelGenerator
extends java.lang.Object
implements CategorySeriesLabelGenerator, Cloneable, PublicCloneable, Serializable
A standard series label generator for plots that use data from a CategoryDataset.

Field Summary

static String
DEFAULT_LABEL_FORMAT
The default item label format.

Constructor Summary

StandardCategorySeriesLabelGenerator()
Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).
StandardCategorySeriesLabelGenerator(String format)
Creates a new series label generator.

Method Summary

Object
clone()
Returns an independent copy of the generator.
protected Object[]
createItemArray(CategoryDataset 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(CategoryDataset dataset, int series)
Generates a label for the specified series.
int
hashCode()
Returns a hash code for this instance.

Field Details

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT
The default item label format.

Constructor Details

StandardCategorySeriesLabelGenerator

public StandardCategorySeriesLabelGenerator()
Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).

StandardCategorySeriesLabelGenerator

public StandardCategorySeriesLabelGenerator(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.
Returns:
A clone.

createItemArray

protected Object[] createItemArray(CategoryDataset 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(CategoryDataset dataset,
                            int series)
Generates a label for the specified series.
Specified by:
generateLabel in interface CategorySeriesLabelGenerator
Parameters:
dataset - the dataset (null not permitted).
series - the series.
Returns:
A series label.

hashCode

public int hashCode()
Returns a hash code for this instance.
Returns:
A hash code.

Overview Package Class Use Source Tree Index Deprecated About