KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > urls > CategoryURLGenerator


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6  *
7  * Project Info: http://www.jfree.org/jfreechart/index.html
8  *
9  * This library is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17  * License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -------------------------
27  * CategoryURLGenerator.java
28  * -------------------------
29  * (C) Copyright 2002-2005, by Richard Atkinson and Contributors.
30  *
31  * Original Author: Richard Atkinson;
32  * Contributors: David Gilbert (for Object Refinery Limited);
33  *
34  * $Id: CategoryURLGenerator.java,v 1.3 2005/03/09 13:45:32 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 05-Aug-2002 : Version 1, contributed by Richard Atkinson;
39  * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
40  * 10-Apr-2003 : Replaced reference to CategoryDataset with
41  * KeyedValues2DDataset (DG);
42  * 23-Apr-2003 : Switched around CategoryDataset and KeyedValues2DDataset
43  * (again) (DG);
44  * 13-Aug-2003 : Added clone() method (DG);
45  * 14-Jun-2004 : Removed clone() method - classes that implement the interface
46  * should implement the PublicCloneable interface instead,
47  * wherever possible (DG);
48  *
49  */
50
51 package org.jfree.chart.urls;
52
53 import org.jfree.data.category.CategoryDataset;
54
55 /**
56  * A URL generator for items in a {@link CategoryDataset}.
57  *
58  * @author Richard Atkinson
59  */
60 public interface CategoryURLGenerator {
61
62     /**
63      * Returns a URL for one item in a dataset. As a guideline, the URL
64      * should be valid within the context of an XHTML 1.0 document.
65      *
66      * @param data the dataset.
67      * @param series the series (zero-based index).
68      * @param category the category.
69      *
70      * @return A string containing the URL.
71      */
72     public String JavaDoc generateURL(CategoryDataset data, int series, int category);
73
74 }
75
Popular Tags