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 * IntervalCategoryDataset.java
029 * ----------------------------
030 * (C) Copyright 2002-present, by Eduard Martinescu and Contributors.
031 *
032 * Original Author:  Eduard Martinescu;
033 * Contributor(s):   David Gilbert;
034 *
035 */
036
037package org.jfree.data.category;
038
039/**
040 * A category dataset that defines a value range for each series/category
041 * combination.
042 */
043public interface IntervalCategoryDataset extends CategoryDataset {
044
045    /**
046     * Returns the start value for the interval for a given series and category.
047     *
048     * @param series  the series (zero-based index).
049     * @param category  the category (zero-based index).
050     *
051     * @return The start value (possibly {@code null}).
052     *
053     * @see #getEndValue(int, int)
054     */
055    Number getStartValue(int series, int category);
056
057    /**
058     * Returns the start value for the interval for a given series and category.
059     *
060     * @param series  the series key.
061     * @param category  the category key.
062     *
063     * @return The start value (possibly {@code null}).
064     *
065     * @see #getEndValue(Comparable, Comparable)
066     */
067    Number getStartValue(Comparable series, Comparable category);
068
069    /**
070     * Returns the end value for the interval for a given series and category.
071     *
072     * @param series  the series (zero-based index).
073     * @param category  the category (zero-based index).
074     *
075     * @return The end value (possibly {@code null}).
076     *
077     * @see #getStartValue(int, int)
078     */
079    Number getEndValue(int series, int category);
080
081    /**
082     * Returns the end value for the interval for a given series and category.
083     *
084     * @param series  the series key.
085     * @param category  the category key.
086     *
087     * @return The end value (possibly {@code null}).
088     *
089     * @see #getStartValue(Comparable, Comparable)
090     */
091    Number getEndValue(Comparable series, Comparable category);
092
093}