public class

StandardXYURLGenerator

extends Object
implements Serializable XYURLGenerator
java.lang.Object
   ↳ org.jfree.chart.urls.StandardXYURLGenerator
Known Direct Subclasses

Class Overview

A URL generator.

Summary

Constants
String DEFAULT_ITEM_PARAMETER The default item parameter.
String DEFAULT_PREFIX The default prefix.
String DEFAULT_SERIES_PARAMETER The default series parameter.
Public Constructors
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
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.urls.XYURLGenerator

Constants

public static final String DEFAULT_ITEM_PARAMETER

The default item parameter.

Constant Value: "item"

public static final String DEFAULT_PREFIX

The default prefix.

Constant Value: "index.html"

public static final String DEFAULT_SERIES_PARAMETER

The default series parameter.

Constant Value: "series"

Public Constructors

public StandardXYURLGenerator ()

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

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

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

Public Methods

public boolean equals (Object obj)

Tests this generator for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

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.