public class

CustomPieURLGenerator

extends Object
implements Serializable Cloneable PieURLGenerator
java.lang.Object
   ↳ org.jfree.chart.urls.CustomPieURLGenerator

Class Overview

A custom URL generator for pie charts.

Summary

Public Constructors
CustomPieURLGenerator()
Creates a new CustomPieURLGenerator instance, initially empty.
Public Methods
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 pieIndex)
Generates a URL fragment.
int getListCount()
Returns the number of URL maps stored by the renderer.
String getURL(Comparable key, int mapIndex)
Returns the URL for a section in the specified map.
int getURLCount(int list)
Returns the number of URLs in a given map (specified by its position in the map list).
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.urls.PieURLGenerator

Public Constructors

public CustomPieURLGenerator ()

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

Public Methods

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

public Object clone ()

Returns a clone of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public boolean equals (Object o)

Tests if this object is equal to another.

Parameters
o the other object.
Returns
  • A boolean.

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

public int getListCount ()

Returns the number of URL maps stored by the renderer.

Returns
  • The list count.
See Also

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.

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