KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > labels > XYSeriesLabelGenerator


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
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  * XYSeriesLabelGenerator.java
29  * ---------------------------
30  * (C) Copyright 2004, by Object Refinery Limited.
31  *
32  * Original Author: David Gilbert (for Object Refinery Limited);
33  * Contributor(s): -;
34  *
35  * $Id: XYSeriesLabelGenerator.java,v 1.2.2.1 2005/10/25 20:49:02 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 16-Nov-2004 : Version 1 (DG);
40  *
41  */
42
43 package org.jfree.chart.labels;
44
45 import org.jfree.data.xy.XYDataset;
46
47 /**
48  * A generator that creates labels for the series in an {@link XYDataset}.
49  */
50 public interface XYSeriesLabelGenerator {
51
52     /**
53      * Generates a label for the specified series. This label will be
54      * used for the chart legend.
55      *
56      * @param dataset the dataset.
57      * @param series the series.
58      *
59      * @return A series label.
60      */
61     public String JavaDoc generateLabel(XYDataset dataset, int series);
62
63 }
64
Popular Tags