Source for org.jfree.chart.urls.XYURLGenerator

   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:  * XYURLGenerator.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:  * 20-Jan-2005 : Minor Javadoc update (DG);
  40:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  41:  * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
  42:  * 13-Dec-2007 : Updated API docs (DG);
  43:  *
  44:  */
  45: 
  46: package org.jfree.chart.urls;
  47: 
  48: import org.jfree.data.xy.XYDataset;
  49: 
  50: /**
  51:  * Interface for a URL generator for plots that uses data from an 
  52:  * {@link XYDataset}.  Classes that implement this interface are responsible 
  53:  * for correctly escaping any text that is derived from the dataset, as this 
  54:  * may be user-specified and could pose a security risk.
  55:  */
  56: public interface XYURLGenerator {
  57: 
  58:     /**
  59:      * Generates a URL for a particular item within a series. As a guideline, 
  60:      * the URL should be valid within the context of an XHTML 1.0 document.
  61:      *
  62:      * @param dataset  the dataset (<code>null</code> not permitted).
  63:      * @param series  the series index (zero-based).
  64:      * @param item  the item index (zero-based).
  65:      *
  66:      * @return A string containing the generated URL (possibly 
  67:      *         <code>null</code>).
  68:      */
  69:     public String generateURL(XYDataset dataset, int series, int item);
  70: 
  71: }