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