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 * PieURLGenerator.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 * 07-Mar-2003 : Modified to use KeyedValuesDataset and added pieIndex
40 * parameter (DG);
41 * 24-Apr-2003 : Switched around PieDataset and KeyedValuesDataset (DG);
42 * ------------- JFREECHART 1.0.x ---------------------------------------------
43 * 24-Nov-2006 : Updated API docs (DG);
44 * 13-Dec-2007 : Updated API docs (DG);
45 *
46 */
47
48 package org.jfree.chart.urls;
49
50 import org.jfree.data.general.PieDataset;
51
52 /**
53 * Interface for a URL generator for plots that use data from a
54 * {@link PieDataset}. Classes that implement this interface:
55 * <ul>
56 * <li>are responsible for correctly escaping any text that is derived from the
57 * dataset, as this may be user-specified and could pose a security
58 * risk;</li>
59 * <li>should be either (a) immutable, or (b) cloneable via the
60 * <code>PublicCloneable</code> interface (defined in the JCommon class
61 * library). This provides a mechanism for the referring plot to clone
62 * the generator if necessary.</li>
63 * </ul>
64 */
65 public interface PieURLGenerator {
66
67 /**
68 * Generates a URL for one item in a {@link PieDataset}. As a guideline,
69 * the URL should be valid within the context of an XHTML 1.0 document.
70 *
71 * @param dataset the dataset (<code>null</code> not permitted).
72 * @param key the item key (<code>null</code> not permitted).
73 * @param pieIndex the pie index (differentiates between pies in a
74 * 'multi' pie chart).
75 *
76 * @return A string containing the URL.
77 */
78 public String generateURL(PieDataset dataset, Comparable key, int pieIndex);
79
80 }
Save This Page