org.jfree.chart.urls

Class CustomPieURLGenerator

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

A custom URL generator for pie charts.
Constructor Summary
CustomPieURLGenerator()
Creates a new CustomPieURLGenerator instance, initially empty.
Method Summary
voidaddURLs(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.
Objectclone()
Returns a clone of the generator.
booleanequals(Object o)
Tests if this object is equal to another.
StringgenerateURL(PieDataset dataset, Comparable key, int pieIndex)
Generates a URL fragment.
intgetListCount()
Returns the number of URL maps stored by the renderer.
StringgetURL(Comparable key, int mapIndex)
Returns the URL for a section in the specified map.
intgetURLCount(int list)
Returns the number of URLs in a given map (specified by its position in the map list).

Constructor Detail

CustomPieURLGenerator

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

Method Detail

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).

clone

public Object clone()
Returns a clone of the generator.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not supported.

equals

public boolean equals(Object o)
Tests if this object is equal to another.

Parameters: o the other object.

Returns: A boolean.

generateURL

public String generateURL(PieDataset dataset, Comparable key, int pieIndex)
Generates a URL fragment.

Parameters: dataset the dataset (ignored). key the item key. pieIndex the pie index.

Returns: A string containing the generated URL.

See Also: CustomPieURLGenerator

getListCount

public int getListCount()
Returns the number of URL maps stored by the renderer.

Returns: The list count.

See Also: addURLs

getURL

public String getURL(Comparable key, int mapIndex)
Returns the URL for a section in the specified map.

Parameters: key the key. mapIndex the map index.

Returns: The URL.

getURLCount

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

Parameters: list the list index (zero based).

Returns: The URL count.

See Also: getListCount