KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > general > SeriesDataset


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2006, 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  * SeriesDataset.java
29  * ------------------
30  * (C) Copyright 2000-2006, by Object Refinery Limited.
31  *
32  * Original Author: David Gilbert (for Object Refinery Limited);
33  * Contributor(s): -;
34  *
35  * $Id: SeriesDataset.java,v 1.4.2.2 2006/07/06 16:13:48 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 17-Nov-2001 : Version 1 (DG);
40  * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);
41  * 19-May-2005 : Changed getSeriesName() --> getSeriesKey() and added indexOf()
42  * method (DG);
43  *
44  */
45
46 package org.jfree.data.general;
47
48 import org.jfree.data.category.CategoryDataset;
49 import org.jfree.data.xy.IntervalXYDataset;
50 import org.jfree.data.xy.IntervalXYZDataset;
51 import org.jfree.data.xy.XYDataset;
52 import org.jfree.data.xy.XYZDataset;
53
54 /**
55  * The interface for a dataset consisting of one or many series of data.
56  *
57  * @see CategoryDataset
58  * @see IntervalXYDataset
59  * @see IntervalXYZDataset
60  * @see XYDataset
61  * @see XYZDataset
62  */
63 public interface SeriesDataset extends Dataset {
64
65     /**
66      * Returns the number of series in the dataset.
67      *
68      * @return The series count.
69      */
70     public int getSeriesCount();
71
72     /**
73      * Returns the key for a series.
74      *
75      * @param series the series index (in the range <code>0</code> to
76      * <code>getSeriesCount() - 1</code>).
77      *
78      * @return The key for the series.
79      */
80     public Comparable JavaDoc getSeriesKey(int series);
81
82     /**
83      * Returns the index of the series with the specified key, or -1 if there
84      * is no such series in the dataset.
85      *
86      * @param seriesKey the series key (<code>null</code> permitted).
87      *
88      * @return The index, or -1.
89      */
90     public int indexOf(Comparable JavaDoc seriesKey);
91     
92 }
93
Popular Tags