001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * --------------------
028 * PieURLGenerator.java
029 * --------------------
030 * (C) Copyright 2002-present, by Richard Atkinson and Contributors.
031 *
032 * Original Author:  Richard Atkinson;
033 * Contributors:     David Gilbert;
034 *
035 */
036
037package org.jfree.chart.urls;
038
039import org.jfree.data.general.PieDataset;
040
041/**
042 * Interface for a URL generator for plots that use data from a
043 * {@link PieDataset}.  Classes that implement this interface:
044 * <ul>
045 * <li>are responsible for correctly escaping any text that is derived from the
046 *     dataset, as this may be user-specified and could pose a security
047 *     risk;</li>
048 * <li>should be either (a) immutable, or (b) cloneable via the
049 *     {@code PublicCloneable} interface (defined in the JCommon class
050 *     library).  This provides a mechanism for the referring plot to clone
051 *     the generator if necessary.</li>
052 * </ul>
053 */
054public interface PieURLGenerator {
055
056    /**
057     * Generates a URL for one item in a {@link PieDataset}. As a guideline,
058     * the URL should be valid within the context of an XHTML 1.0 document.
059     *
060     * @param dataset  the dataset ({@code null} not permitted).
061     * @param key  the item key ({@code null} not permitted).
062     * @param pieIndex  the pie index (differentiates between pies in a
063     *                  'multi' pie chart).
064     *
065     * @return A string containing the URL.
066     */
067    String generateURL(PieDataset dataset, Comparable key, int pieIndex);
068
069}