org.jfree.chart.urls

Class StandardCategoryURLGenerator

public class StandardCategoryURLGenerator extends Object implements CategoryURLGenerator, Cloneable, Serializable

A URL generator that can be assigned to a CategoryItemRenderer.
Constructor Summary
StandardCategoryURLGenerator()
Creates a new generator with default settings.
StandardCategoryURLGenerator(String prefix)
Constructor that overrides default prefix to the URL.
StandardCategoryURLGenerator(String prefix, String seriesParameterName, String categoryParameterName)
Constructor that overrides all the defaults.
Method Summary
Objectclone()
Returns an independent copy of the URL generator.
booleanequals(Object obj)
Tests the generator for equality with an arbitrary object.
StringgenerateURL(CategoryDataset dataset, int series, int category)
Generates a URL for a particular item within a series.
inthashCode()
Returns a hash code.

Constructor Detail

StandardCategoryURLGenerator

public StandardCategoryURLGenerator()
Creates a new generator with default settings.

StandardCategoryURLGenerator

public StandardCategoryURLGenerator(String prefix)
Constructor that overrides default prefix to the URL.

Parameters: prefix the prefix to the URL (null not permitted).

StandardCategoryURLGenerator

public StandardCategoryURLGenerator(String prefix, String seriesParameterName, String categoryParameterName)
Constructor that overrides all the defaults.

Parameters: prefix the prefix to the URL (null not permitted). seriesParameterName the name of the series parameter to go in each URL (null not permitted). categoryParameterName the name of the category parameter to go in each URL (null not permitted).

Method Detail

clone

public Object clone()
Returns an independent copy of the URL generator.

Returns: A clone.

Throws: CloneNotSupportedException not thrown by this class, but subclasses (if any) might.

equals

public boolean equals(Object obj)
Tests the generator for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

generateURL

public String generateURL(CategoryDataset dataset, int series, int category)
Generates a URL for a particular item within a series.

Parameters: dataset the dataset. series the series index (zero-based). category the category index (zero-based).

Returns: The generated URL.

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.