public class

StandardCategoryURLGenerator

extends Object
implements Serializable Cloneable CategoryURLGenerator
java.lang.Object
   ↳ org.jfree.chart.urls.StandardCategoryURLGenerator

Class Overview

A URL generator that can be assigned to a CategoryItemRenderer.

Summary

Public Constructors
StandardCategoryURLGenerator()
Creates a new generator with default settings.
StandardCategoryURLGenerator(String prefix)
Constructor that overrides default prefix to the URL.
StandardCategoryURLGenerator(String prefix, String seriesParameterName, String categoryParameterName)
Constructor that overrides all the defaults.
Public Methods
Object clone()
Returns an independent copy of the URL generator.
boolean equals(Object obj)
Tests the generator for equality with an arbitrary object.
String generateURL(CategoryDataset dataset, int series, int category)
Generates a URL for a particular item within a series.
int hashCode()
Returns a hash code.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.urls.CategoryURLGenerator

Public Constructors

public StandardCategoryURLGenerator ()

Creates a new generator with default settings.

public StandardCategoryURLGenerator (String prefix)

Constructor that overrides default prefix to the URL.

Parameters
prefix the prefix to the URL (null not permitted).

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

Public Methods

public Object clone ()

Returns an independent copy of the URL generator.

Returns
  • A clone.
Throws
CloneNotSupportedException not thrown by this class, but subclasses (if any) might.

public boolean equals (Object obj)

Tests the generator for equality with an arbitrary object.

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

public String generateURL (CategoryDataset dataset, int series, int category)

Generates a URL for a particular item within a series.

Parameters
dataset the dataset.
series the series index (zero-based).
category the category index (zero-based).
Returns
  • The generated URL.

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.