Class StandardCategoryURLGenerator

java.lang.Object
org.jfree.chart.urls.StandardCategoryURLGenerator
All Implemented Interfaces:
Serializable, Cloneable, CategoryURLGenerator

public class StandardCategoryURLGenerator
extends Object
implements CategoryURLGenerator, Cloneable, Serializable
A URL generator that can be assigned to a CategoryItemRenderer.
Author:
Richard Atkinson
See Also:
Serialized Form
  • Constructor Details

    • StandardCategoryURLGenerator

      public StandardCategoryURLGenerator()
      Creates a new generator with default settings.
    • StandardCategoryURLGenerator

      public StandardCategoryURLGenerator​(String prefix)
      Constructor that overrides default prefix to the URL.
      Parameters:
      prefix - the prefix to the URL (null not permitted).
    • StandardCategoryURLGenerator

      public StandardCategoryURLGenerator​(String prefix, String seriesParameterName, String categoryParameterName)
      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).
      categoryParameterName - the name of the category parameter to go in each URL (null not permitted).
  • Method Details

    • generateURL

      public String generateURL​(CategoryDataset dataset, int series, int category)
      Generates a URL for a particular item within a series.
      Specified by:
      generateURL in interface CategoryURLGenerator
      Parameters:
      dataset - the dataset.
      series - the series index (zero-based).
      category - the category index (zero-based).
      Returns:
      The generated URL.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns an independent copy of the URL generator.
      Specified by:
      clone in interface CategoryURLGenerator
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - not thrown by this class, but subclasses (if any) might.
    • equals

      public boolean equals​(Object obj)
      Tests the generator for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.
    • hashCode

      public int hashCode()
      Returns a hash code.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code.