org.jfree.chart.urls

Class CustomXYURLGenerator

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable, XYURLGenerator

public class CustomXYURLGenerator
extends java.lang.Object
implements XYURLGenerator, Cloneable, PublicCloneable, Serializable

A custom URL generator.

Constructor Summary

CustomXYURLGenerator()
Default constructor.

Method Summary

void
addURLSeries(List urls)
Adds a list of URLs.
Object
clone()
Returns a new generator that is a copy of, and independent from, this generator.
boolean
equals(Object obj)
Tests this generator for equality with an arbitrary object.
String
generateURL(XYDataset dataset, int series, int item)
Generates a URL.
int
getListCount()
Returns the number of URL lists stored by the renderer.
String
getURL(int series, int item)
Returns the URL for an item.
int
getURLCount(int list)
Returns the number of URLs in a given list.

Constructor Details

CustomXYURLGenerator

public CustomXYURLGenerator()
Default constructor.

Method Details

addURLSeries

public void addURLSeries(List urls)
Adds a list of URLs.
Parameters:
urls - the list of URLs (null permitted, the list is copied).

clone

public Object clone()
            throws CloneNotSupportedException
Returns a new generator that is a copy of, and independent from, this generator.
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this generator for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

generateURL

public String generateURL(XYDataset dataset,
                          int series,
                          int item)
Generates a URL.
Specified by:
generateURL in interface XYURLGenerator
Parameters:
dataset - the dataset.
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
A string containing the URL (possibly null).

getListCount

public int getListCount()
Returns the number of URL lists stored by the renderer.
Returns:
The list count.

getURL

public String getURL(int series,
                     int item)
Returns the URL for an item.
Parameters:
series - the series index.
item - the item index.
Returns:
The URL (possibly null).

getURLCount

public int getURLCount(int list)
Returns the number of URLs in a given list.
Parameters:
list - the list index (zero based).
Returns:
The URL count.