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 * AbstractSeriesDataset.java
029 * --------------------------
030 * (C) Copyright 2001-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.data.general;
038
039import java.io.Serializable;
040
041/**
042 * An abstract implementation of the {@link SeriesDataset} interface,
043 * containing a mechanism for registering change listeners.
044 */
045public abstract class AbstractSeriesDataset<S extends Comparable<S>> 
046        extends AbstractDataset 
047        implements SeriesDataset<S>, SeriesChangeListener, Serializable {
048
049    /** For serialization. */
050    private static final long serialVersionUID = -6074996219705033171L;
051
052    /**
053     * Creates a new dataset.
054     */
055    protected AbstractSeriesDataset() {
056        super();
057    }
058
059    /**
060     * Returns the number of series in the dataset.
061     *
062     * @return The series count.
063     */
064    @Override
065    public abstract int getSeriesCount();
066
067    /**
068     * Returns the key for a series.
069     * <p>
070     * If {@code series} is not within the specified range, the
071     * implementing method should throw an {@link IndexOutOfBoundsException}
072     * (preferred) or an {@link IllegalArgumentException}.
073     *
074     * @param series  the series index (in the range {@code 0} to
075     *     {@code getSeriesCount() - 1}).
076     *
077     * @return The series key.
078     */
079    @Override
080    public abstract S getSeriesKey(int series);
081
082    /**
083     * Returns the index of the named series, or -1.
084     *
085     * @param seriesKey  the series key ({@code null} permitted).
086     *
087     * @return The index.
088     */
089    @Override
090    public int indexOf(S seriesKey) {
091        int seriesCount = getSeriesCount();
092        for (int s = 0; s < seriesCount; s++) {
093           if (getSeriesKey(s).equals(seriesKey)) {
094               return s;
095           }
096        }
097        return -1;
098    }
099
100    /**
101     * Called when a series belonging to the dataset changes.
102     *
103     * @param event  information about the change.
104     */
105    @Override
106    public void seriesChanged(SeriesChangeEvent event) {
107        fireDatasetChanged();
108    }
109
110}