Source for org.jfree.chart.urls.PieURLGenerator

   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:  *
  45:  */
  46: package org.jfree.chart.urls;
  47: 
  48: import org.jfree.data.general.PieDataset;
  49: 
  50: /**
  51:  * Interface for a URL generator for plots that use data from a 
  52:  * {@link PieDataset}.
  53:  * <P>
  54:  * Classes that implement this interface should be either (a) immutable, or
  55:  * (b) cloneable via the <code>PublicCloneable</code> interface (defined in 
  56:  * the JCommon class library).  This provides a mechanism for the referring
  57:  * plot to clone the generator if necessary.
  58:  */
  59: public interface PieURLGenerator {
  60: 
  61:     /**
  62:      * Generates a URL for one item in a {@link PieDataset}. As a guideline, 
  63:      * the URL should be valid within the context of an XHTML 1.0 document.
  64:      *
  65:      * @param dataset  the dataset (<code>null</code> not permitted).
  66:      * @param key  the item key (<code>null</code> not permitted).
  67:      * @param pieIndex  the pie index (differentiates between pies in a 
  68:      *                  'multi' pie chart).
  69:      *
  70:      * @return A string containing the URL.
  71:      */
  72:     public String generateURL(PieDataset dataset, Comparable key, int pieIndex);
  73: 
  74: }