org.jfree.chart.urls

Class StandardXYURLGenerator

public class StandardXYURLGenerator extends Object implements XYURLGenerator, Serializable

A URL generator.
Field Summary
static StringDEFAULT_ITEM_PARAMETER
The default item parameter.
static StringDEFAULT_PREFIX
The default prefix.
static StringDEFAULT_SERIES_PARAMETER
The default series parameter.
Constructor Summary
StandardXYURLGenerator()
Creates a new default generator.
StandardXYURLGenerator(String prefix)
Creates a new generator with the specified prefix.
StandardXYURLGenerator(String prefix, String seriesParameterName, String itemParameterName)
Constructor that overrides all the defaults
Method Summary
booleanequals(Object obj)
Tests this generator for equality with an arbitrary object.
StringgenerateURL(XYDataset dataset, int series, int item)
Generates a URL for a particular item within a series.

Field Detail

DEFAULT_ITEM_PARAMETER

public static final String DEFAULT_ITEM_PARAMETER
The default item parameter.

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX
The default prefix.

DEFAULT_SERIES_PARAMETER

public static final String DEFAULT_SERIES_PARAMETER
The default series parameter.

Constructor Detail

StandardXYURLGenerator

public StandardXYURLGenerator()
Creates a new default generator. This constructor is equivalent to calling StandardXYURLGenerator("index.html", "series", "item"); .

StandardXYURLGenerator

public StandardXYURLGenerator(String prefix)
Creates a new generator with the specified prefix. This constructor is equivalent to calling StandardXYURLGenerator(prefix, "series", "item");.

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

StandardXYURLGenerator

public StandardXYURLGenerator(String prefix, String seriesParameterName, String itemParameterName)
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). itemParameterName the name of the item parameter to go in each URL (null not permitted).

Method Detail

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 for a particular item within a series.

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

Returns: The generated URL.