Module platform

Class TimeSeriesURLGenerator

java.lang.Object
org.jfree.chart.urls.TimeSeriesURLGenerator
All Implemented Interfaces:
Serializable, XYURLGenerator

public class TimeSeriesURLGenerator extends Object implements XYURLGenerator, Serializable
A URL generator for time series charts.
See Also:
  • 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 (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).
  • Method Details

    • getDateFormat

      public DateFormat getDateFormat()
      Returns a clone of the date format assigned to this URL generator.
      Returns:
      The date format (never null).
    • getPrefix

      public String getPrefix()
      Returns the prefix string.
      Returns:
      The prefix string (never null).
    • getSeriesParameterName

      public String getSeriesParameterName()
      Returns the series parameter name.
      Returns:
      The series parameter name (never null).
    • getItemParameterName

      public String getItemParameterName()
      Returns the item parameter name.
      Returns:
      The item parameter name (never null).
    • 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 (null not permitted).
      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.