01: /* ===========================================================
02: * JFreeChart : a free chart library for the Java(tm) platform
03: * ===========================================================
04: *
05: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jfreechart/index.html
08: *
09: * 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: * $Id: XYURLGenerator.java,v 1.4.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: * 20-Jan-2005 : Minor Javadoc update (DG);
42: * ------------- JFREECHART 1.0.x ---------------------------------------------
43: * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
44: *
45: */
46:
47: package org.jfree.chart.urls;
48:
49: import org.jfree.data.xy.XYDataset;
50:
51: /**
52: * Interface for a URL generator for plots that uses data from an
53: * {@link XYDataset}.
54: */
55: public interface XYURLGenerator {
56:
57: /**
58: * Generates a URL for a particular item within a series. As a guideline,
59: * the URL should be valid within the context of an XHTML 1.0 document.
60: *
61: * @param dataset the dataset (<code>null</code> not permitted).
62: * @param series the series index (zero-based).
63: * @param item the item index (zero-based).
64: *
65: * @return A string containing the generated URL (possibly
66: * <code>null</code>).
67: */
68: public String generateURL(XYDataset dataset, int series, int item);
69:
70: }
|