001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -------------------------------
028 * StatisticalCategoryDataset.java
029 * -------------------------------
030 * (C) Copyright 2002-present, by Pascal Collet and Contributors.
031 *
032 * Original Author:  Pascal Collet;
033 * Contributor(s):   David Gilbert;
034 *
035 */
036
037package org.jfree.data.statistics;
038
039import org.jfree.data.category.CategoryDataset;
040
041/**
042 * A category dataset that defines a mean and standard deviation value for
043 * each item.
044 */
045public interface StatisticalCategoryDataset extends CategoryDataset {
046
047    /**
048     * Returns the mean value for an item.
049     *
050     * @param row  the row index (zero-based).
051     * @param column  the column index (zero-based).
052     *
053     * @return The mean value (possibly {@code null}).
054     */
055    Number getMeanValue(int row, int column);
056
057    /**
058     * Returns the mean value for an item.
059     *
060     * @param rowKey  the row key.
061     * @param columnKey  the columnKey.
062     *
063     * @return The mean value (possibly {@code null}).
064     */
065    Number getMeanValue(Comparable rowKey, Comparable columnKey);
066
067    /**
068     * Returns the standard deviation value for an item.
069     *
070     * @param row  the row index (zero-based).
071     * @param column  the column index (zero-based).
072     *
073     * @return The standard deviation (possibly {@code null}).
074     */
075    Number getStdDevValue(int row, int column);
076
077    /**
078     * Returns the standard deviation value for an item.
079     *
080     * @param rowKey  the row key.
081     * @param columnKey  the columnKey.
082     *
083     * @return The standard deviation (possibly {@code null}).
084     */
085    Number getStdDevValue(Comparable rowKey, Comparable columnKey);
086
087}
088