org.jfree.chart.urls
Class StandardCategoryURLGenerator

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

public class StandardCategoryURLGenerator
extends java.lang.Object
implements CategoryURLGenerator, java.lang.Cloneable, java.io.Serializable

A URL generator.

Author:
Richard Atkinson
See Also:
Serialized Form

Constructor Summary
StandardCategoryURLGenerator()
          Blank constructor
StandardCategoryURLGenerator(java.lang.String prefix)
          Constructor that overrides default prefix to the URL.
StandardCategoryURLGenerator(java.lang.String prefix, java.lang.String seriesParameterName, java.lang.String categoryParameterName)
          Constructor that overrides all the defaults.
 
Method Summary
 java.lang.Object clone()
          Returns an independent copy of the URL generator.
 boolean equals(java.lang.Object o)
          Tests if this object is equal to another.
 java.lang.String generateURL(CategoryDataset data, int series, int category)
          Generates a URL for a particular item within a series.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardCategoryURLGenerator

public StandardCategoryURLGenerator()
Blank constructor


StandardCategoryURLGenerator

public StandardCategoryURLGenerator(java.lang.String prefix)
Constructor that overrides default prefix to the URL.

Parameters:
prefix - the prefix to the URL

StandardCategoryURLGenerator

public StandardCategoryURLGenerator(java.lang.String prefix,
                                    java.lang.String seriesParameterName,
                                    java.lang.String categoryParameterName)
Constructor that overrides all the defaults.

Parameters:
prefix - the prefix to the URL.
seriesParameterName - the name of the series parameter to go in each URL.
categoryParameterName - the name of the category parameter to go in each URL.
Method Detail

generateURL

public java.lang.String generateURL(CategoryDataset data,
                                    int series,
                                    int category)
Generates a URL for a particular item within a series.

Specified by:
generateURL in interface CategoryURLGenerator
Parameters:
data - the dataset.
series - the series index (zero-based).
category - the category index (zero-based).
Returns:
the generated URL.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns an independent copy of the URL generator.

Specified by:
clone in interface CategoryURLGenerator
Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - not thrown by this class, but subclasses (if any) might.

equals

public boolean equals(java.lang.Object o)
Tests if this object is equal to another.

Parameters:
o - the other object.
Returns:
A boolean.