Source for org.jfree.data.general.SeriesDataset

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