Module org.jfree.chart

Package org.jfree.chart.urls

Class CustomXYURLGenerator

java.lang.Object

org.jfree.chart.urls.CustomXYURLGenerator

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable, XYURLGenerator

public class CustomXYURLGenerator
extends Object
implements XYURLGenerator, Cloneable, PublicCloneable, Serializable

A custom URL generator.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CustomXYURLGenerator()	Default constructor.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomXYURLGenerator

public CustomXYURLGenerator()

Default constructor.

Method Detail

getListCount

public int getListCount()

Returns the number of URL lists stored by the renderer.

Returns:

The list count.

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.

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

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

addURLSeries

public void addURLSeries(List urls)

Adds a list of URLs.

Parameters:

urls - the list of URLs (null permitted, the list is copied).

equals

public boolean equals(Object obj)

Tests this generator for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a new generator that is a copy of, and independent from, this generator.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem with cloning.