Module org.jfree.chart

Package org.jfree.chart.urls

Class StandardPieURLGenerator

java.lang.Object

org.jfree.chart.urls.StandardPieURLGenerator

All Implemented Interfaces:

Serializable, PieURLGenerator

public class StandardPieURLGenerator
extends Object
implements PieURLGenerator, Serializable

A URL generator for pie charts. Instances of this class are immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StandardPieURLGenerator()	Default constructor.
StandardPieURLGenerator(String prefix)	Creates a new generator.
StandardPieURLGenerator(String prefix, String categoryParamName)	Creates a new generator.
StandardPieURLGenerator(String prefix, String categoryParamName, String indexParamName)	Creates a new generator.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests if this object is equal to another.
String	generateURL(PieDataset dataset, Comparable key, int pieIndex)	Generates a URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardPieURLGenerator

public StandardPieURLGenerator()

Default constructor.

StandardPieURLGenerator

public StandardPieURLGenerator(String prefix)

Creates a new generator.

Parameters:

prefix - the prefix (null not permitted).

StandardPieURLGenerator

public StandardPieURLGenerator(String prefix,
                               String categoryParamName)

Creates a new generator.

Parameters:

prefix - the prefix (null not permitted).

categoryParamName - the category parameter name (null not permitted).

StandardPieURLGenerator

public StandardPieURLGenerator(String prefix,
                               String categoryParamName,
                               String indexParamName)

Creates a new generator.

Parameters:

prefix - the prefix (null not permitted).

categoryParamName - the category parameter name (null not permitted).

indexParamName - the index parameter name (null permitted).

Method Detail

generateURL

public String generateURL(PieDataset dataset,
                          Comparable key,
                          int pieIndex)

Generates a URL.

Specified by:

generateURL in interface PieURLGenerator

Parameters:

dataset - the dataset (ignored).

key - the item key (null not permitted).

pieIndex - the pie index.

Returns:

A string containing the generated URL.

equals

public boolean equals(Object obj)

Tests if this object is equal to another.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.