Module org.jfree.chart

Package org.jfree.chart.urls

Class CustomPieURLGenerator

java.lang.Object

org.jfree.chart.urls.CustomPieURLGenerator

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable, PieURLGenerator

public class CustomPieURLGenerator
extends Object
implements PieURLGenerator, Cloneable, PublicCloneable, Serializable

A custom URL generator for pie charts. This implementation supports both the standard PiePlot as well as MultiplePiePlot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CustomPieURLGenerator()	Creates a new CustomPieURLGenerator instance, initially empty.

Method Summary

Modifier and Type	Method	Description
void	addURLs(Map urlMap)	Adds a map containing (key, URL) mappings where each key is an instance of Comparable (corresponding to the key for an item in a pie dataset) and each URL is a String representing a URL fragment.
Object	clone()	Returns a clone of the generator.
boolean	equals(Object o)	Tests if this object is equal to another.
String	generateURL(PieDataset dataset, Comparable<?> key, int plotIndex)	Generates a URL fragment.
int	getListCount()	Returns the number of URL maps stored by the generator.
String	getURL(Comparable<?> key, int plotIndex)	Returns the URL for a section in the specified map.
int	getURLCount(int plotIndex)	Returns the number of URLs in a given map (specified by its position in the map list).

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomPieURLGenerator

public CustomPieURLGenerator()

Creates a new CustomPieURLGenerator instance, initially empty. Call addURLs(Map) to specify the URL fragments to be used.

Method Detail

generateURL

public String generateURL(PieDataset dataset,
                          Comparable<?> key,
                          int plotIndex)

Generates a URL fragment.

Specified by:

generateURL in interface PieURLGenerator

Parameters:

dataset - the dataset (ignored).

key - the item key.

plotIndex - the plot index.

Returns:

A string containing the generated URL.

See Also:

getURL(Comparable, int)

getListCount

public int getListCount()

Returns the number of URL maps stored by the generator. For a standard pie chart, only one map is required, but for a MultiplePiePlot the generator will use multiple maps.

Returns:

The list count.

See Also:

addURLs(Map)

getURLCount

public int getURLCount(int plotIndex)

Returns the number of URLs in a given map (specified by its position in the map list).

Parameters:

plotIndex - the plot index (zero based).

Returns:

The URL count.

See Also:

getListCount()

getURL

public String getURL(Comparable<?> key,
                     int plotIndex)

Returns the URL for a section in the specified map.

Parameters:

key - the key.

plotIndex - the plot index.

Returns:

The URL.

addURLs

public void addURLs(Map urlMap)

Adds a map containing (key, URL) mappings where each key is an instance of Comparable (corresponding to the key for an item in a pie dataset) and each URL is a String representing a URL fragment.

The map is appended to an internal list...you can add multiple maps if you are working with, say, a MultiplePiePlot.

Parameters:

urlMap - the URLs (null permitted).

equals

public boolean equals(Object o)

Tests if this object is equal to another.

Overrides:

equals in class Object

Parameters:

o - the other object.

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the generator.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - if cloning is not supported.