1 /* ===========================================================
2 * JFreeChart : a free chart library for the Java(tm) platform
3 * ===========================================================
4 *
5 * (C) Copyright 2000-2007, 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
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 * USA.
23 *
24 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25 * in the United States and other countries.]
26 *
27 * -------------------------
28 * CategoryURLGenerator.java
29 * -------------------------
30 * (C) Copyright 2002-2007, by Richard Atkinson and Contributors.
31 *
32 * Original Author: Richard Atkinson;
33 * Contributors: David Gilbert (for Object Refinery Limited);
34 *
35 * Changes:
36 * --------
37 * 05-Aug-2002 : Version 1, contributed by Richard Atkinson;
38 * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
39 * 10-Apr-2003 : Replaced reference to CategoryDataset with
40 * KeyedValues2DDataset (DG);
41 * 23-Apr-2003 : Switched around CategoryDataset and KeyedValues2DDataset
42 * (again) (DG);
43 * 13-Aug-2003 : Added clone() method (DG);
44 * 14-Jun-2004 : Removed clone() method - classes that implement the interface
45 * should implement the PublicCloneable interface instead,
46 * wherever possible (DG);
47 * ------------- JFREECHART 1.0.x ---------------------------------------------
48 * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
49 * 13-Dec-2007 : Updated API docs (DG);
50 *
51 */
52
53 package org.jfree.chart.urls;
54
55 import org.jfree.data.category.CategoryDataset;
56
57 /**
58 * A URL generator for items in a {@link CategoryDataset}.
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. Classes
65 * that implement this interface are responsible for correctly escaping
66 * any text that is derived from the dataset, as this may be user-specified
67 * and could pose a security risk.
68 *
69 * @param dataset the dataset.
70 * @param series the series (zero-based index).
71 * @param category the category.
72 *
73 * @return A string containing the URL.
74 */
75 public String generateURL(CategoryDataset dataset, int series,
76 int category);
77
78 }
Save This Page