org.jfree.chart.labels

Class MultipleXYSeriesLabelGenerator

public class MultipleXYSeriesLabelGenerator extends Object implements XYSeriesLabelGenerator, Cloneable, PublicCloneable, Serializable

A series label generator for plots that use data from an XYDataset.

Field Summary
static String	DEFAULT_LABEL_FORMAT The default item label format.

Constructor Summary
	MultipleXYSeriesLabelGenerator() Creates an item label generator using default number formatters.
	MultipleXYSeriesLabelGenerator(String format) Creates a new series label generator.

Method Summary
void	addSeriesLabel(int series, String label) Adds an extra label for the specified series.
void	clearSeriesLabels(int series) Clears the extra labels for the specified series.
Object	clone() Returns an independent copy of the generator.
protected Object[]	createItemArray(XYDataset 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(XYDataset dataset, int series) Generates a label for the specified series.
int	hashCode() Returns a hash code for this instance.

Field Detail

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT

The default item label format.

Constructor Detail

MultipleXYSeriesLabelGenerator

public MultipleXYSeriesLabelGenerator()

Creates an item label generator using default number formatters.

MultipleXYSeriesLabelGenerator

public MultipleXYSeriesLabelGenerator(String format)

Creates a new series label generator.

Parameters: format the format pattern (null not permitted).

Method Detail

addSeriesLabel

public void addSeriesLabel(int series, 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.

clone

public Object clone()

Returns an independent copy of the generator.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not supported.

createItemArray

protected Object[] createItemArray(XYDataset 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(XYDataset dataset, int series)

Generates a label for the specified series. This label will be used for the chart legend.

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.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.