org.jfree.chart.labels

Class AbstractXYItemLabelGenerator

java.lang.Object

org.jfree.chart.labels.AbstractXYItemLabelGenerator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BubbleXYItemLabelGenerator, IntervalXYItemLabelGenerator, StandardXYItemLabelGenerator, StandardXYToolTipGenerator

public class AbstractXYItemLabelGenerator
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A base class for creating item label generators.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	formatString The item label format string.
private java.lang.String	nullYString The string used to represent 'null' for the y-value.
private static long	serialVersionUID For serialization.
private java.text.DateFormat	xDateFormat A date formatter for the x value.
private java.text.NumberFormat	xFormat A number formatter for the x value.
private java.text.DateFormat	yDateFormat A date formatter for the y value.
private java.text.NumberFormat	yFormat A formatter for the y value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXYItemLabelGenerator() Creates an item label generator using default number formatters.
protected	AbstractXYItemLabelGenerator(java.lang.String formatString, java.text.DateFormat xFormat, java.text.DateFormat yFormat) Creates an item label generator using the specified number formatters.
protected	AbstractXYItemLabelGenerator(java.lang.String formatString, java.text.DateFormat xFormat, java.text.NumberFormat yFormat) Creates an item label generator using the specified number formatters.
protected	AbstractXYItemLabelGenerator(java.lang.String formatString, java.text.NumberFormat xFormat, java.text.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).
protected	AbstractXYItemLabelGenerator(java.lang.String formatString, java.text.NumberFormat xFormat, java.text.NumberFormat yFormat) Creates an item label generator using the specified number formatters.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns an independent copy of the generator.
protected java.lang.Object[]	createItemArray(XYDataset dataset, int series, int item) 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	generateLabelString(XYDataset dataset, int series, int item) Generates a label string for an item in the dataset.
java.lang.String	getFormatString() Returns the format string (this controls the overall structure of the label).
java.lang.String	getNullYString() Returns the string representing a null value.
java.text.DateFormat	getXDateFormat() Returns the date formatter for the x-values.
java.text.NumberFormat	getXFormat() Returns the number formatter for the x-values.
java.text.DateFormat	getYDateFormat() Returns the date formatter for the y-values.
java.text.NumberFormat	getYFormat() Returns the number formatter for the y-values.
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

formatString

private java.lang.String formatString

The item label format string.

xFormat

private java.text.NumberFormat xFormat

A number formatter for the x value.

xDateFormat

private java.text.DateFormat xDateFormat

A date formatter for the x value.

yFormat

private java.text.NumberFormat yFormat

A formatter for the y value.

yDateFormat

private java.text.DateFormat yDateFormat

A date formatter for the y value.

nullYString

private java.lang.String nullYString

The string used to represent 'null' for the y-value.

Constructor Detail

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator()

Creates an item label generator using default number formatters.

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(java.lang.String formatString,
                                       java.text.NumberFormat xFormat,
                                       java.text.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).

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(java.lang.String formatString,
                                       java.text.DateFormat xFormat,
                                       java.text.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 permitted).

yFormat - the format object for the y values (null not permitted).

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(java.lang.String formatString,
                                       java.text.NumberFormat xFormat,
                                       java.text.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).

Since:

1.0.4

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(java.lang.String formatString,
                                       java.text.DateFormat xFormat,
                                       java.text.DateFormat 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 permitted).

yFormat - the format object for the y values (null not permitted).

Method Detail

getFormatString

public java.lang.String getFormatString()

Returns the format string (this controls the overall structure of the label).

Returns:

The format string (never null).

getXFormat

public java.text.NumberFormat getXFormat()

Returns the number formatter for the x-values.

Returns:

The number formatter (possibly null).

getXDateFormat

public java.text.DateFormat getXDateFormat()

Returns the date formatter for the x-values.

Returns:

The date formatter (possibly null).

getYFormat

public java.text.NumberFormat getYFormat()

Returns the number formatter for the y-values.

Returns:

The number formatter (possibly null).

getYDateFormat

public java.text.DateFormat getYDateFormat()

Returns the date formatter for the y-values.

Returns:

The date formatter (possibly null).

generateLabelString

public java.lang.String generateLabelString(XYDataset dataset,
                                            int series,
                                            int item)

Generates a label string for an item in the dataset.

Parameters:

dataset - the dataset (null not permitted).

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

The label (possibly null).

getNullYString

public java.lang.String getNullYString()

Returns the string representing a null value.

Returns:

The string representing a null value.

Since:

1.0.10

createItemArray

protected java.lang.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 three items from the dataset formatted as String objects (never null).

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.

clone

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

Returns an independent copy of the generator.

Overrides:

clone in class java.lang.Object

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if cloning is not supported.