01: /* ===========================================================
02: * JFreeChart : a free chart library for the Java(tm) platform
03: * ===========================================================
04: *
05: * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jfreechart/index.html
08: *
09: * 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-2006, by Richard Atkinson and Contributors.
31: *
32: * Original Author: Richard Atkinson;
33: * Contributors: David Gilbert (for Object Refinery Limited);
34: *
35: * $Id: PieURLGenerator.java,v 1.3.2.2 2006/11/24 10:47:27 mungady Exp $
36: *
37: * Changes:
38: * --------
39: * 05-Aug-2002 : Version 1, contributed by Richard Atkinson;
40: * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
41: * 07-Mar-2003 : Modified to use KeyedValuesDataset and added pieIndex
42: * parameter (DG);
43: * 24-Apr-2003 : Switched around PieDataset and KeyedValuesDataset (DG);
44: * ------------- JFREECHART 1.0.x ---------------------------------------------
45: * 24-Nov-2006 : Updated API docs (DG);
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}.
55: * <P>
56: * Classes that implement this interface should be either (a) immutable, or
57: * (b) cloneable via the <code>PublicCloneable</code> interface (defined in
58: * the JCommon class library). This provides a mechanism for the referring
59: * plot to clone the generator if necessary.
60: */
61: public interface PieURLGenerator {
62:
63: /**
64: * Generates a URL for one item in a {@link PieDataset}. As a guideline,
65: * the URL should be valid within the context of an XHTML 1.0 document.
66: *
67: * @param dataset the dataset (<code>null</code> not permitted).
68: * @param key the item key (<code>null</code> not permitted).
69: * @param pieIndex the pie index (differentiates between pies in a
70: * 'multi' pie chart).
71: *
72: * @return A string containing the URL.
73: */
74: public String generateURL(PieDataset dataset, Comparable key,
75: int pieIndex);
76:
77: }
|