public class

TimeSeriesURLGenerator

extends Object
implements Serializable XYURLGenerator
java.lang.Object
   ↳ org.jfree.chart.urls.TimeSeriesURLGenerator

Class Overview

A URL generator for time series charts.

Summary

Public Constructors
TimeSeriesURLGenerator()
Default constructor.
TimeSeriesURLGenerator(DateFormat dateFormat, String prefix, String seriesParameterName, String itemParameterName)
Construct TimeSeriesURLGenerator overriding 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.
DateFormat getDateFormat()
Returns a clone of the date format assigned to this URL generator.
String getItemParameterName()
Returns the item parameter name.
String getPrefix()
Returns the prefix string.
String getSeriesParameterName()
Returns the series parameter name.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.urls.XYURLGenerator

Public Constructors

public TimeSeriesURLGenerator ()

Default constructor.

public TimeSeriesURLGenerator (DateFormat dateFormat, String prefix, String seriesParameterName, String itemParameterName)

Construct TimeSeriesURLGenerator overriding defaults.

Parameters
dateFormat a formatter for the date (null not permitted).
prefix the prefix of the URL (null not permitted).
seriesParameterName the name of the series parameter in the URL (null not permitted).
itemParameterName the name of the item parameter in the 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 (null not permitted).
series the series number (zero-based index).
item the item number (zero-based index).
Returns
  • The generated URL.

public DateFormat getDateFormat ()

Returns a clone of the date format assigned to this URL generator.

Returns
  • The date format (never null).

public String getItemParameterName ()

Returns the item parameter name.

Returns
  • The item parameter name (never null).

public String getPrefix ()

Returns the prefix string.

Returns
  • The prefix string (never null).

public String getSeriesParameterName ()

Returns the series parameter name.

Returns
  • The series parameter name (never null).