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