Source for org.jfree.data.category.IntervalCategoryDataset

   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:  * IntervalCategoryDataset.java
  29:  * ----------------------------
  30:  * (C) Copyright 2002-2004, by Eduard Martinescu and Contributors.
  31:  *
  32:  * Original Author:  Eduard Martinescu;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: IntervalCategoryDataset.java,v 1.2.2.1 2005/10/25 21:29:58 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 19-Mar-2002 : Version 1 contributed by Eduard Martinescu.  The interface 
  40:  *               name and method names have been renamed to be consistent with 
  41:  *               existing interfaces (DG);
  42:  * 06-Jun-2002 : Updated Javadoc comments (DG);
  43:  * 24-Oct-2002 : Categories and series are now indexed by int or Comparable, 
  44:  *               following changes made to the CategoryDataset interface (DG);
  45:  *
  46:  */
  47: 
  48: package org.jfree.data.category;
  49: 
  50: 
  51: /**
  52:  * A category dataset that defines a value range for each series/category 
  53:  * combination.
  54:  *
  55:  * @author Eduard Martinescu
  56:  */
  57: public interface IntervalCategoryDataset extends CategoryDataset {
  58: 
  59:     /**
  60:      * Returns the start value for the interval for a given series and category.
  61:      *
  62:      * @param series  the series (zero-based index).
  63:      * @param category  the category (zero-based index).
  64:      *
  65:      * @return The start value (possibly <code>null</code>).
  66:      */
  67:     public Number getStartValue(int series, int category);
  68: 
  69:     /**
  70:      * Returns the start value for the interval for a given series and category.
  71:      *
  72:      * @param series  the series key.
  73:      * @param category  the category key.
  74:      *
  75:      * @return The start value (possibly <code>null</code>).
  76:      */
  77:     public Number getStartValue(Comparable series, Comparable category);
  78: 
  79:     /**
  80:      * Returns the end value for the interval for a given series and category.
  81:      *
  82:      * @param series  the series (zero-based index).
  83:      * @param category  the category (zero-based index).
  84:      *
  85:      * @return The end value (possibly <code>null</code>).
  86:      */
  87:     public Number getEndValue(int series, int category);
  88: 
  89:     /**
  90:      * Returns the end value for the interval for a given series and category.
  91:      *
  92:      * @param series  the series key.
  93:      * @param category  the category key.
  94:      *
  95:      * @return The end value (possibly <code>null</code>).
  96:      */
  97:     public Number getEndValue(Comparable series, Comparable category);
  98: 
  99: }