org.jfree.chart.labels

Class IntervalXYItemLabelGenerator

public class IntervalXYItemLabelGenerator extends AbstractXYItemLabelGenerator implements XYItemLabelGenerator, Cloneable, PublicCloneable, Serializable

An item label generator for datasets that implement the IntervalXYDataset interface.

Since: 1.0.10

Field Summary
static StringDEFAULT_ITEM_LABEL_FORMAT
The default item label format.
Constructor Summary
IntervalXYItemLabelGenerator()
Creates an item label generator using default number formatters.
IntervalXYItemLabelGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified number formatters.
IntervalXYItemLabelGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified formatters.
IntervalXYItemLabelGenerator(String formatString, NumberFormat xFormat, DateFormat yFormat)
Creates an item label generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).
IntervalXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)
Creates a label generator using the specified date formatters.
Method Summary
Objectclone()
Returns an independent copy of the generator.
protected Object[]createItemArray(XYDataset dataset, int series, int item)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
StringgenerateLabel(XYDataset dataset, int series, int item)
Generates the item label text for an item in a dataset.

Field Detail

DEFAULT_ITEM_LABEL_FORMAT

public static final String DEFAULT_ITEM_LABEL_FORMAT
The default item label format.

Constructor Detail

IntervalXYItemLabelGenerator

public IntervalXYItemLabelGenerator()
Creates an item label generator using default number formatters.

IntervalXYItemLabelGenerator

public IntervalXYItemLabelGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified number formatters.

Parameters: formatString the item label format string (null not permitted). xFormat the format object for the x values (null not permitted). yFormat the format object for the y values (null not permitted).

IntervalXYItemLabelGenerator

public IntervalXYItemLabelGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified formatters.

Parameters: formatString the item label format string (null not permitted). xFormat the format object for the x values (null not permitted). yFormat the format object for the y values (null not permitted).

IntervalXYItemLabelGenerator

public IntervalXYItemLabelGenerator(String formatString, NumberFormat xFormat, DateFormat yFormat)
Creates an item label generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).

Parameters: formatString the item label format string (null not permitted). xFormat the format object for the x values (null permitted). yFormat the format object for the y values (null not permitted).

IntervalXYItemLabelGenerator

public IntervalXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)
Creates a label generator using the specified date formatters.

Parameters: formatString the label format string (null not permitted). xFormat the format object for the x values (null not permitted). yFormat the format object for the y values (null not permitted).

Method Detail

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, int item)
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). item the item (zero-based index).

Returns: An array of seven items from the dataset formatted as String objects (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, int item)
Generates the item label text for an item in a dataset.

Parameters: dataset the dataset (null not permitted). series the series index (zero-based). item the item index (zero-based).

Returns: The label text (possibly null).