KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > urls > XYURLGenerator


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2005, 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 License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -------------------
27  * XYURLGenerator.java
28  * -------------------
29  * (C) Copyright 2002-2005, by Richard Atkinson and Contributors.
30  *
31  * Original Author: Richard Atkinson;
32  * Contributors: David Gilbert (for Object Refinery Limited);
33  *
34  * $Id: XYURLGenerator.java,v 1.4 2005/03/09 13:45:32 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 05-Aug-2002 : Version 1, contributed by Richard Atkinson;
39  * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
40  * 20-Jan-2005 : Minor Javadoc update (DG);
41  *
42  */
43
44 package org.jfree.chart.urls;
45
46 import org.jfree.data.xy.XYDataset;
47
48 /**
49  * Interface for a URL generator for plots that uses data from an
50  * {@link XYDataset}.
51  *
52  * @author Richard Atkinson
53  */
54 public interface XYURLGenerator {
55
56     /**
57      * Generates a URL for a particular item within a series. As a guideline,
58      * the URL should be valid within the context of an XHTML 1.0 document.
59      *
60      * @param dataset the dataset (<code>null</code> not permitted).
61      * @param series the series index (zero-based).
62      * @param item the item index (zero-based).
63      *
64      * @return A string containing the generated URL (possibly
65      * <code>null</code>).
66      */
67     public String JavaDoc generateURL(XYDataset dataset, int series, int item);
68
69 }
70
Popular Tags