Package org.jfree.chart.labels

Class StandardCategorySeriesLabelGenerator

java.lang.Object

org.jfree.chart.labels.StandardCategorySeriesLabelGenerator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CategorySeriesLabelGenerator, PublicCloneable

public class StandardCategorySeriesLabelGenerator
extends java.lang.Object
implements CategorySeriesLabelGenerator, java.lang.Cloneable, PublicCloneable, java.io.Serializable

A standard series label generator for plots that use data from a CategoryDataset.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_LABEL_FORMAT	The default item label format.
private java.lang.String	formatPattern	The format pattern.
private static long	serialVersionUID	For serialization.

Constructor Summary

Constructors

Constructor	Description
StandardCategorySeriesLabelGenerator()	Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).
StandardCategorySeriesLabelGenerator(java.lang.String format)	Creates a new series label generator.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Returns an independent copy of the generator.
protected java.lang.Object[]	createItemArray(CategoryDataset dataset, int series)	Creates the array of items that can be passed to the MessageFormat class for creating labels.
boolean	equals(java.lang.Object obj)	Tests this object for equality with an arbitrary object.
java.lang.String	generateLabel(CategoryDataset 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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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.

Constructor Detail

StandardCategorySeriesLabelGenerator

public StandardCategorySeriesLabelGenerator()

Creates a default series label generator (uses DEFAULT_LABEL_FORMAT).

StandardCategorySeriesLabelGenerator

public StandardCategorySeriesLabelGenerator(java.lang.String format)

Creates a new series label generator.

Parameters:

format - the format pattern (null not permitted).

Method Detail

generateLabel

public java.lang.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.

createItemArray

protected java.lang.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).

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns an independent copy of the generator.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class java.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 class java.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 class java.lang.Object

Returns:

A hash code.