KickJava   Java API By Example, From Geeks To Geeks.

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


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  * PieURLGenerator.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: PieURLGenerator.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  * 07-Mar-2003 : Modified to use KeyedValuesDataset and added pieIndex
41  * parameter (DG);
42  * 24-Apr-2003 : Switched around PieDataset and KeyedValuesDataset (DG);
43  *
44  */
45 package org.jfree.chart.urls;
46
47 import org.jfree.data.general.PieDataset;
48
49 /**
50  * Interface for a URL generator for plots that use data from a
51  * {@link PieDataset}.
52  *
53  * @author Richard Atkinson
54  */
55 public interface PieURLGenerator {
56
57     /**
58      * Generates a URL for one item in a {@link PieDataset}. As a guideline,
59      * the URL should be valid within the context of an XHTML 1.0 document.
60      *
61      * @param dataset the dataset (<code>null</code> not permitted).
62      * @param key the item key.
63      * @param pieIndex the pie index (differentiates between pies in a
64      * 'multi' pie chart).
65      *
66      * @return A string containing the URL.
67      */
68     public String JavaDoc generateURL(PieDataset dataset, Comparable JavaDoc key, int pieIndex);
69
70 }
71
Popular Tags