    001    /* ===========================================================
    002     * JFreeChart : a free chart library for the Java(tm) platform
    003     * ===========================================================
    004     *
    005     * (C) Copyright 2000-2005, by Object Refinery Limited 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     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
    025     * in the United States and other countries.]
    026     *
    027     * ---------------------------
    028     * BoxAndWhiskerXYDataset.java
    029     * ---------------------------
    030     * (C) Copyright 2003, by David Browning and Contributors.
    031     *
    032     * Original Author:  David Browning (for Australian Institute of Marine
    033     *                   Science);
    034     * Contributor(s):   David Gilbert (for Object Refinery Limited);
    035     *
    036     * $Id: BoxAndWhiskerXYDataset.java,v 1.3.2.1 2005/10/25 21:34:46 mungady Exp $
    037     *
    038     * Changes
    039     * -------
    040     * 05-Aug-2003 : Version 1, contributed by David Browning (DG);
    041     * 12-Aug-2003 : Added new methods: getMaxNonOutlierValue
    042     *                                  getMaxNonFaroutValue
    043     *                                  getOutlierCoefficient
    044     *                                  setOutlierCoefficient
    045     *                                  getFaroutCoefficient
    046     *                                  setFaroutCoefficient
    047     *                                  getInterquartileRange (DB)
    048     * 27-Aug-2003 : Renamed BoxAndWhiskerDataset --> BoxAndWhiskerXYDataset, and
    049     *               cut down methods (DG);
    050     *
    051     */
    052
    053    package org.jfree.data.statistics;
    054
    055    import java.util.List;
    056
    057    import org.jfree.data.xy.XYDataset;
    058
    059    /**
    060     * An interface that defines data in the form of (x, max, min, average, median)
    061     * tuples.
    062     * <P>
    063     * Example: JFreeChart uses this interface to obtain data for AIMS
    064     * max-min-average-median plots.
    065     *
    066     * @author David Browning
    067     */
    068    public interface BoxAndWhiskerXYDataset extends XYDataset {
    069
    070        /**
    071         * Returns the mean for the specified series and item.
    072         *
    073         * @param series  the series (zero-based index).
    074         * @param item  the item (zero-based index).
    075         *
    076         * @return The mean for the specified series and item.
    077         */
    078        public Number getMeanValue(int series, int item);
    079
    080        /**
    081         * Returns the median-value for the specified series and item.
    082         *
    083         * @param series  the series (zero-based index).
    084         * @param item  the item (zero-based index).
    085         *
    086         * @return The median-value for the specified series and item.
    087         */
    088        public Number getMedianValue(int series, int item);
    089
    090        /**
    091         * Returns the Q1 median-value for the specified series and item.
    092         *
    093         * @param series  the series (zero-based index).
    094         * @param item  the item (zero-based index).
    095         *
    096         * @return The Q1 median-value for the specified series and item.
    097         */
    098        public Number getQ1Value(int series, int item);
    099
    100        /**
    101         * Returns the Q3 median-value for the specified series and item.
    102         *
    103         * @param series  the series (zero-based index).
    104         * @param item  the item (zero-based index).
    105         *
    106         * @return The Q3 median-value for the specified series and item.
    107         */
    108        public Number getQ3Value(int series, int item);
    109
    110        /**
    111         * Returns the min-value for the specified series and item.
    112         *
    113         * @param series  the series (zero-based index).
    114         * @param item  the item (zero-based index).
    115         *
    116         * @return The min-value for the specified series and item.
    117         */
    118        public Number getMinRegularValue(int series, int item);
    119
    120        /**
    121         * Returns the max-value for the specified series and item.
    122         *
    123         * @param series  the series (zero-based index).
    124         * @param item  the item (zero-based index).
    125         *
    126         * @return The max-value for the specified series and item.
    127         */
    128        public Number getMaxRegularValue(int series, int item);
    129
    130        /**
    131         * Returns the minimum value which is not a farout.
    132         * @param series  the series (zero-based index).
    133         * @param item  the item (zero-based index).
    134         *
    135         * @return A <code>Number</code> representing the maximum non-farout value.
    136         */
    137        public Number getMinOutlier(int series, int item);
    138
    139        /**
    140         * Returns the maximum value which is not a farout, ie Q3 + (interquartile
    141         * range * farout coefficient).
    142         *
    143         * @param series  the series (zero-based index).
    144         * @param item  the item (zero-based index).
    145         *
    146         * @return A <code>Number</code> representing the maximum non-farout value.
    147         */
    148        public Number getMaxOutlier(int series, int item);
    149
    150        /**
    151         * Returns an array of outliers for the specified series and item.
    152         *
    153         * @param series  the series (zero-based index).
    154         * @param item  the item (zero-based index).
    155         *
    156         * @return The array of outliers for the specified series and item.
    157         */
    158        public List getOutliers(int series, int item);
    159
    160        /**
    161         * Returns the value used as the outlier coefficient. The outlier
    162         * coefficient gives an indication of the degree of certainty in an
    163         * unskewed distribution.  Increasing the coefficient increases the number
    164         * of values included.  Currently only used to ensure farout coefficient
    165         * is greater than the outlier coefficient
    166         *
    167         * @return A <code>double</code> representing the value used to calculate
    168         *         outliers
    169         */
    170        public double getOutlierCoefficient();
    171
    172        /**
    173         * Returns the value used as the farout coefficient. The farout coefficient
    174         * allows the calculation of which values will be off the graph.
    175         *
    176         * @return A <code>double</code> representing the value used to calculate
    177         *         farouts
    178         */
    179        public double getFaroutCoefficient();
    180
    181    }