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 * IntervalCategoryDataset.java
029 * ----------------------------
030 * (C) Copyright 2002-2020, 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<R extends Comparable<R>, 
044        C extends Comparable<C>> extends CategoryDataset<R, C> {
045
046    /**
047     * Returns the start value for the interval for a given series and category.
048     *
049     * @param series  the series (zero-based index).
050     * @param category  the category (zero-based index).
051     *
052     * @return The start value (possibly {@code null}).
053     *
054     * @see #getEndValue(int, int)
055     */
056    Number getStartValue(int series, int category);
057
058    /**
059     * Returns the start value for the interval for a given series and category.
060     *
061     * @param series  the series key.
062     * @param category  the category key.
063     *
064     * @return The start value (possibly {@code null}).
065     *
066     * @see #getEndValue(Comparable, Comparable)
067     */
068    Number getStartValue(R series, C category);
069
070    /**
071     * Returns the end value for the interval for a given series and category.
072     *
073     * @param series  the series (zero-based index).
074     * @param category  the category (zero-based index).
075     *
076     * @return The end value (possibly {@code null}).
077     *
078     * @see #getStartValue(int, int)
079     */
080    Number getEndValue(int series, int category);
081
082    /**
083     * Returns the end value for the interval for a given series and category.
084     *
085     * @param series  the series key.
086     * @param category  the category key.
087     *
088     * @return The end value (possibly {@code null}).
089     *
090     * @see #getStartValue(Comparable, Comparable)
091     */
092    Number getEndValue(R series, C category);
093
094}