001    /* ===========================================================
002     * JFreeChart : a free chart library for the Java(tm) platform
003     * ===========================================================
004     *
005     * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006     *
007     * Project Info:  http://www.jfree.org/jfreechart/index.html
008     *
009     * This library is free software; you can redistribute it and/or modify it 
010     * under the terms of the GNU Lesser General Public License as published by 
011     * the Free Software Foundation; either version 2.1 of the License, or 
012     * (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but 
015     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
016     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
017     * License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this library; if not, write to the Free Software
021     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
022     * USA.  
023     *
024     * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025     * in the United States and other countries.]
026     *
027     * -------------------------
028     * CategoryURLGenerator.java
029     * -------------------------
030     * (C) Copyright 2002-2005, by Richard Atkinson and Contributors.
031     *
032     * Original Author:  Richard Atkinson;
033     * Contributors:     David Gilbert (for Object Refinery Limited);
034     *
035     * $Id: CategoryURLGenerator.java,v 1.3.2.1 2005/10/25 20:59:31 mungady Exp $
036     *
037     * Changes:
038     * --------
039     * 05-Aug-2002 : Version 1, contributed by Richard Atkinson;
040     * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
041     * 10-Apr-2003 : Replaced reference to CategoryDataset with 
042     *               KeyedValues2DDataset (DG);
043     * 23-Apr-2003 : Switched around CategoryDataset and KeyedValues2DDataset 
044     *               (again) (DG);
045     * 13-Aug-2003 : Added clone() method (DG);
046     * 14-Jun-2004 : Removed clone() method - classes that implement the interface 
047     *               should implement the PublicCloneable interface instead, 
048     *               wherever possible (DG);
049     *
050     */
051    
052    package org.jfree.chart.urls;
053    
054    import org.jfree.data.category.CategoryDataset;
055    
056    /**
057     * A URL generator for items in a {@link CategoryDataset}.
058     *
059     * @author Richard Atkinson
060     */
061    public interface CategoryURLGenerator {
062    
063        /**
064         * Returns a URL for one item in a dataset. As a guideline, the URL 
065         * should be valid within the context of an XHTML 1.0 document.
066         *
067         * @param data  the dataset.
068         * @param series  the series (zero-based index).
069         * @param category  the category.
070         *
071         * @return A string containing the URL.
072         */
073        public String generateURL(CategoryDataset data, int series, int category);
074    
075    }