001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, 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-2020, 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<R extends Comparable<R>, 
046        C extends Comparable<C>> extends CategoryDataset<R, C> {
047
048    /**
049     * Returns the mean value for an item.
050     *
051     * @param row  the row index (zero-based).
052     * @param column  the column index (zero-based).
053     *
054     * @return The mean value (possibly {@code null}).
055     */
056    Number getMeanValue(int row, int column);
057
058    /**
059     * Returns the mean value for an item.
060     *
061     * @param rowKey  the row key.
062     * @param columnKey  the columnKey.
063     *
064     * @return The mean value (possibly {@code null}).
065     */
066    Number getMeanValue(R rowKey, C columnKey);
067
068    /**
069     * Returns the standard deviation value for an item.
070     *
071     * @param row  the row index (zero-based).
072     * @param column  the column index (zero-based).
073     *
074     * @return The standard deviation (possibly {@code null}).
075     */
076    Number getStdDevValue(int row, int column);
077
078    /**
079     * Returns the standard deviation value for an item.
080     *
081     * @param rowKey  the row key.
082     * @param columnKey  the columnKey.
083     *
084     * @return The standard deviation (possibly {@code null}).
085     */
086    Number getStdDevValue(R rowKey, C columnKey);
087
088}
089