Source for org.jfree.data.statistics.StatisticalCategoryDataset

   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:  * StatisticalCategoryDataset.java
  29:  * -------------------------------
  30:  * (C) Copyright 2002-2007, by Pascal Collet and Contributors.
  31:  *
  32:  * Original Author:  Pascal Collet;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: StatisticalCategoryDataset.java,v 1.2.2.2 2007/02/02 15:50:24 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 21-Aug-2002 : Version 1, contributed by Pascal Collet (DG);
  40:  * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);
  41:  * 24-Oct-2002 : Amendments in line with changes to the CategoryDataset 
  42:  *               interface (DG);
  43:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  44:  * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
  45:  *
  46:  */
  47: 
  48: package org.jfree.data.statistics;
  49: 
  50: import org.jfree.data.category.CategoryDataset;
  51: 
  52: /**
  53:  * A category dataset that defines a median and standard deviation value for 
  54:  * each item.
  55:  */
  56: public interface StatisticalCategoryDataset extends CategoryDataset {
  57: 
  58:     /**
  59:      * Returns the mean value for an item.
  60:      *
  61:      * @param row  the row index (zero-based).
  62:      * @param column  the column index (zero-based).
  63:      *
  64:      * @return The mean value.
  65:      */
  66:     public Number getMeanValue(int row, int column);
  67: 
  68:     /**
  69:      * Returns the mean value for an item.
  70:      *
  71:      * @param rowKey  the row key.
  72:      * @param columnKey  the columnKey.
  73:      *
  74:      * @return The mean value.
  75:      */
  76:     public Number getMeanValue(Comparable rowKey, Comparable columnKey);
  77: 
  78:     /**
  79:      * Returns the standard deviation value for an item.
  80:      *
  81:      * @param row  the row index (zero-based).
  82:      * @param column  the column index (zero-based).
  83:      *
  84:      * @return The standard deviation.
  85:      */
  86:     public Number getStdDevValue(int row, int column);
  87: 
  88:     /**
  89:      * Returns the standard deviation value for an item.
  90:      *
  91:      * @param rowKey  the row key.
  92:      * @param columnKey  the columnKey.
  93:      *
  94:      * @return The standard deviation.
  95:      */
  96:     public Number getStdDevValue(Comparable rowKey, Comparable columnKey);
  97: 
  98: }
  99: