- java.lang.Object
-
- org.jfree.chart.labels.StandardCategorySeriesLabelGenerator
-
- All Implemented Interfaces:
Serializable,Cloneable,PublicCloneable,CategorySeriesLabelGenerator
public class StandardCategorySeriesLabelGenerator extends Object implements CategorySeriesLabelGenerator, Cloneable, PublicCloneable, Serializable
A standard series label generator for plots that use data from aCategoryDataset.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_LABEL_FORMATThe default item label format.
-
Constructor Summary
Constructors Constructor Description StandardCategorySeriesLabelGenerator()Creates a default series label generator (usesDEFAULT_LABEL_FORMAT).StandardCategorySeriesLabelGenerator(String format)Creates a new series label generator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Returns an independent copy of the generator.protected Object[]createItemArray(CategoryDataset dataset, int series)Creates the array of items that can be passed to theMessageFormatclass for creating labels.booleanequals(Object obj)Tests this object for equality with an arbitrary object.StringgenerateLabel(CategoryDataset dataset, int series)Generates a label for the specified series.inthashCode()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
-
StandardCategorySeriesLabelGenerator
public StandardCategorySeriesLabelGenerator()
Creates a default series label generator (usesDEFAULT_LABEL_FORMAT).
-
StandardCategorySeriesLabelGenerator
public StandardCategorySeriesLabelGenerator(String format)
Creates a new series label generator.- Parameters:
format- the format pattern (nullnot permitted).
-
-
Method Detail
-
generateLabel
public String generateLabel(CategoryDataset dataset, int series)
Generates a label for the specified series.- Specified by:
generateLabelin interfaceCategorySeriesLabelGenerator- Parameters:
dataset- the dataset (nullnot permitted).series- the series.- Returns:
- A series label.
-
createItemArray
protected Object[] createItemArray(CategoryDataset dataset, int series)
Creates the array of items that can be passed to theMessageFormatclass for creating labels.- Parameters:
dataset- the dataset (nullnot 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:
clonein interfacePublicCloneable- Overrides:
clonein classObject- Returns:
- A clone.
- Throws:
CloneNotSupportedException- if cloning is not supported.
-
-