org.jfree.chart.labels

Class AbstractPieItemLabelGenerator

public class AbstractPieItemLabelGenerator extends Object implements Serializable

A base class used for generating pie chart item labels.
Constructor Summary
protected AbstractPieItemLabelGenerator(String labelFormat, NumberFormat numberFormat, NumberFormat percentFormat)
Creates an item label generator using the specified number formatters.
Method Summary
Objectclone()
Returns an independent copy of the generator.
protected Object[]createItemArray(PieDataset dataset, Comparable key)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
booleanequals(Object obj)
Tests the generator for equality with an arbitrary object.
protected StringgenerateSectionLabel(PieDataset dataset, Comparable key)
Generates a label for a pie section.
StringgetLabelFormat()
Returns the label format string.
NumberFormatgetNumberFormat()
Returns the number formatter.
NumberFormatgetPercentFormat()
Returns the percent formatter.
inthashCode()
Returns a hash code for this instance.

Constructor Detail

AbstractPieItemLabelGenerator

protected AbstractPieItemLabelGenerator(String labelFormat, NumberFormat numberFormat, NumberFormat percentFormat)
Creates an item label generator using the specified number formatters.

Parameters: labelFormat the label format string (null not permitted). numberFormat the format object for the values (null not permitted). percentFormat the format object for the percentages (null not permitted).

Method Detail

clone

public Object clone()
Returns an independent copy of the generator.

Returns: A clone.

Throws: CloneNotSupportedException should not happen.

createItemArray

protected Object[] createItemArray(PieDataset dataset, Comparable key)
Creates the array of items that can be passed to the MessageFormat class for creating labels. The returned array contains four values:

Parameters: dataset the dataset (null not permitted). key the key (null not permitted).

Returns: The items (never null).

equals

public boolean equals(Object obj)
Tests the generator for equality with an arbitrary object.

Parameters: obj the object to test against (null permitted).

Returns: A boolean.

generateSectionLabel

protected String generateSectionLabel(PieDataset dataset, Comparable key)
Generates a label for a pie section.

Parameters: dataset the dataset (null not permitted). key the section key (null not permitted).

Returns: The label (possibly null).

getLabelFormat

public String getLabelFormat()
Returns the label format string.

Returns: The label format string (never null).

getNumberFormat

public NumberFormat getNumberFormat()
Returns the number formatter.

Returns: The formatter (never null).

getPercentFormat

public NumberFormat getPercentFormat()
Returns the percent formatter.

Returns: The formatter (never null).

hashCode

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

Returns: A hash code.