Package org.jfree.chart.urls
Class TimeSeriesURLGenerator
java.lang.Object
org.jfree.chart.urls.TimeSeriesURLGenerator
- All Implemented Interfaces:
Serializable,XYURLGenerator
A URL generator for time series charts.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DateFormatA formatter for the date.private StringName to use to identify the itemprivate StringPrefix to the URLprivate static final longFor serialization.private StringName to use to identify the series -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.TimeSeriesURLGenerator(DateFormat dateFormat, String prefix, String seriesParameterName, String itemParameterName) Construct TimeSeriesURLGenerator overriding defaults. -
Method Summary
Modifier and TypeMethodDescriptionbooleanTests this generator for equality with an arbitrary object.generateURL(XYDataset dataset, int series, int item) Generates a URL for a particular item within a series.Returns a clone of the date format assigned to this URL generator.Returns the item parameter name.Returns the prefix string.Returns the series parameter name.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor serialization.- See Also:
-
dateFormat
A formatter for the date. -
prefix
Prefix to the URL -
seriesParameterName
Name to use to identify the series -
itemParameterName
Name to use to identify the item
-
-
Constructor Details
-
TimeSeriesURLGenerator
public TimeSeriesURLGenerator()Default constructor. -
TimeSeriesURLGenerator
public TimeSeriesURLGenerator(DateFormat dateFormat, String prefix, String seriesParameterName, String itemParameterName) Construct TimeSeriesURLGenerator overriding defaults.- Parameters:
dateFormat- a formatter for the date (nullnot permitted).prefix- the prefix of the URL (nullnot permitted).seriesParameterName- the name of the series parameter in the URL (nullnot permitted).itemParameterName- the name of the item parameter in the URL (nullnot permitted).
-
-
Method Details
-
getDateFormat
Returns a clone of the date format assigned to this URL generator.- Returns:
- The date format (never
null).
-
getPrefix
Returns the prefix string.- Returns:
- The prefix string (never
null).
-
getSeriesParameterName
Returns the series parameter name.- Returns:
- The series parameter name (never
null).
-
getItemParameterName
Returns the item parameter name.- Returns:
- The item parameter name (never
null).
-
generateURL
Generates a URL for a particular item within a series.- Specified by:
generateURLin interfaceXYURLGenerator- Parameters:
dataset- the dataset (nullnot permitted).series- the series number (zero-based index).item- the item number (zero-based index).- Returns:
- The generated URL.
-
equals
Tests this generator for equality with an arbitrary object.
-