Source for org.jfree.chart.urls.CategoryURLGenerator

   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:  * $Id: CategoryURLGenerator.java,v 1.3.2.2 2007/02/02 15:51:05 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:  * 10-Apr-2003 : Replaced reference to CategoryDataset with 
  42:  *               KeyedValues2DDataset (DG);
  43:  * 23-Apr-2003 : Switched around CategoryDataset and KeyedValues2DDataset 
  44:  *               (again) (DG);
  45:  * 13-Aug-2003 : Added clone() method (DG);
  46:  * 14-Jun-2004 : Removed clone() method - classes that implement the interface 
  47:  *               should implement the PublicCloneable interface instead, 
  48:  *               wherever possible (DG);
  49:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  50:  * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
  51:  *
  52:  */
  53: 
  54: package org.jfree.chart.urls;
  55: 
  56: import org.jfree.data.category.CategoryDataset;
  57: 
  58: /**
  59:  * A URL generator for items in a {@link CategoryDataset}.
  60:  */
  61: public interface CategoryURLGenerator {
  62: 
  63:     /**
  64:      * Returns a URL for one item in a dataset. As a guideline, the URL 
  65:      * should be valid within the context of an XHTML 1.0 document.
  66:      *
  67:      * @param data  the dataset.
  68:      * @param series  the series (zero-based index).
  69:      * @param category  the category.
  70:      *
  71:      * @return A string containing the URL.
  72:      */
  73:     public String generateURL(CategoryDataset data, int series, int category);
  74: 
  75: }