Module org.jfree.chart

Package org.jfree.chart.urls

Class StandardXYURLGenerator

java.lang.Object

org.jfree.chart.urls.StandardXYURLGenerator

All Implemented Interfaces:

Serializable, XYURLGenerator

Direct Known Subclasses:

StandardXYZURLGenerator

public class StandardXYURLGenerator
extends Object
implements XYURLGenerator, Serializable

A URL generator.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ITEM_PARAMETER	The default item parameter.
static String	DEFAULT_PREFIX	The default prefix.
static String	DEFAULT_SERIES_PARAMETER	The default series parameter.

Constructor Summary

Constructors

Constructor	Description
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

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests this generator for equality with an arbitrary object.
String	generateURL(XYDataset dataset, int series, int item)	Generates a URL for a particular item within a series.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

The default prefix.

See Also:

Constant Field Values

DEFAULT_SERIES_PARAMETER

public static final String DEFAULT_SERIES_PARAMETER

The default series parameter.

See Also:

Constant Field Values

DEFAULT_ITEM_PARAMETER

public static final String DEFAULT_ITEM_PARAMETER

The default item parameter.

See Also:

Constant Field Values

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

generateURL

public String generateURL(XYDataset dataset,
                          int series,
                          int item)

Generates a URL for a particular item within a series.

Specified by:

generateURL in interface XYURLGenerator

Parameters:

dataset - the dataset.

series - the series number (zero-based index).

item - the item number (zero-based index).

Returns:

The generated URL.

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.