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 * XYZURLGenerator.java
29 * --------------------
30 * (C) Copyright 2003-2007, by Object Refinery Limited and Contributors.
31 *
32 * Original Author: David Gilbert (for Object Refinery Limited);
33 * Contributors: -;
34 *
35 * Changes:
36 * --------
37 * 03-Feb-2003 : Version 1 (DG);
38 * 13-Dec-2007 : Updated API docs (DG);
39 *
40 */
41
42 package org.jfree.chart.urls;
43
44 import org.jfree.data.xy.XYZDataset;
45
46 /**
47 * Interface for a URL generator for plots that uses data from an
48 * {@link XYZDataset}. Classes that implement this interface are responsible
49 * for correctly escaping any text that is derived from the dataset, as this
50 * may be user-specified and could pose a security risk.
51 */
52 public interface XYZURLGenerator extends XYURLGenerator {
53
54 /**
55 * Generates a URL for a particular item within a series. As a guideline,
56 * the URL should be valid within the context of an XHTML 1.0 document.
57 *
58 * @param dataset the dataset (<code>null</code> not permitted).
59 * @param series the series index (zero-based).
60 * @param item the item index (zero-based).
61 *
62 * @return A string containing the generated URL.
63 */
64 public String generateURL(XYZDataset dataset, int series, int item);
65
66 }
Save This Page