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 * SeriesDataset.java
029 * ------------------
030 * (C) Copyright 2000-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.data.general;
038
039import org.jfree.data.category.CategoryDataset;
040import org.jfree.data.xy.IntervalXYDataset;
041import org.jfree.data.xy.IntervalXYZDataset;
042import org.jfree.data.xy.XYDataset;
043import org.jfree.data.xy.XYZDataset;
044
045/**
046 * The interface for a dataset consisting of one or many series of data.
047 *
048 * @param <S> The type for the series keys.
049 * 
050 * @see CategoryDataset
051 * @see IntervalXYDataset
052 * @see IntervalXYZDataset
053 * @see XYDataset
054 * @see XYZDataset
055 */
056public interface SeriesDataset<S extends Comparable<S>> extends Dataset {
057
058    /**
059     * Returns the number of series in the dataset.
060     *
061     * @return The series count.
062     */
063    int getSeriesCount();
064
065    /**
066     * Returns the key for a series.
067     *
068     * @param series  the series index (in the range {@code 0} to
069     *     {@code getSeriesCount() - 1}).
070     *
071     * @return The key for the series.
072     */
073    S getSeriesKey(int series);
074
075    /**
076     * Returns the index of the series with the specified key, or -1 if there
077     * is no such series in the dataset.
078     *
079     * @param seriesKey  the series key ({@code null} permitted).
080     *
081     * @return The index, or -1.
082     */
083    int indexOf(S seriesKey);
084
085}