# XYSeriesCollection.java

    /* ===========================================================
     * JFreeChart : a free chart library for the Java(tm) platform
     * ===========================================================
     *
     * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
     *
     * Project Info:  http://www.jfree.org/jfreechart/index.html
     *
     * This library is free software; you can redistribute it and/or modify it
     * under the terms of the GNU Lesser General Public License as published by
     * the Free Software Foundation; either version 2.1 of the License, or
     * (at your option) any later version.
     *
     * This library is distributed in the hope that it will be useful, but
     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
     * License for more details.
     *
     * You should have received a copy of the GNU Lesser General Public
     * License along with this library; if not, write to the Free Software
     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
     * USA.
     *
     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
     * in the United States and other countries.]
     *
     * -----------------------
     * XYSeriesCollection.java
     * -----------------------
     * (C) Copyright 2001-2008, by Object Refinery Limited and Contributors.
     *
     * Original Author:  David Gilbert (for Object Refinery Limited);
     * Contributor(s):   Aaron Metzger;
     *
     * Changes
     * -------
     * 15-Nov-2001 : Version 1 (DG);
     * 03-Apr-2002 : Added change listener code (DG);
     * 29-Apr-2002 : Added removeSeries, removeAllSeries methods (ARM);
     * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);
     * 26-Mar-2003 : Implemented Serializable (DG);
     * 04-Aug-2003 : Added getSeries() method (DG);
     * 31-Mar-2004 : Modified to use an XYIntervalDelegate.
     * 05-May-2004 : Now extends AbstractIntervalXYDataset (DG);
     * 18-Aug-2004 : Moved from org.jfree.data --> org.jfree.data.xy (DG);
     * 17-Nov-2004 : Updated for changes to DomainInfo interface (DG);
     * 11-Jan-2005 : Removed deprecated code in preparation for 1.0.0 release (DG);
     * 28-Mar-2005 : Fixed bug in getSeries(int) method (1170825) (DG);
     * 05-Oct-2005 : Made the interval delegate a dataset listener (DG);
     * ------------- JFREECHART 1.0.x ---------------------------------------------
     * 27-Nov-2006 : Added clone() override (DG);
     * 08-May-2007 : Added indexOf(XYSeries) method (DG);
     * 03-Dec-2007 : Added getSeries(Comparable) method (DG);
     * 22-Apr-2008 : Implemented PublicCloneable (DG);
     *
     */

    package org.jfree.data.xy;

    import java.io.Serializable;
    import java.util.Collections;
    import java.util.Iterator;
    import java.util.List;

    import org.jfree.data.DomainInfo;
    import org.jfree.data.Range;
    import org.jfree.data.UnknownKeyException;
    import org.jfree.data.general.DatasetChangeEvent;
    import org.jfree.data.general.DatasetUtilities;
    import org.jfree.util.ObjectUtilities;
    import org.jfree.util.PublicCloneable;

    /**
     * Represents a collection of {@link XYSeries} objects that can be used as a
     * dataset.
     */
    public class XYSeriesCollection extends AbstractIntervalXYDataset
            implements IntervalXYDataset, DomainInfo, PublicCloneable,
                       Serializable {

        /** For serialization. */
        private static final long serialVersionUID = -7590013825931496766L;

        /** The series that are included in the collection. */
        private List data;

        /** The interval delegate (used to calculate the start and end x-values). */
        private IntervalXYDelegate intervalDelegate;

        /**
         * Constructs an empty dataset.
         */
        public XYSeriesCollection() {
            this(null);
        }

        /**
         * Constructs a dataset and populates it with a single series.
         *
         * @param series  the series (<code>null</code> ignored).
         */
        public XYSeriesCollection(XYSeries series) {
            this.data = new java.util.ArrayList();
            this.intervalDelegate = new IntervalXYDelegate(this, false);
            addChangeListener(this.intervalDelegate);
            if (series != null) {
                this.data.add(series);
                series.addChangeListener(this);
            }
        }

        /**
         * Adds a series to the collection and sends a {@link DatasetChangeEvent}
         * to all registered listeners.
         *
         * @param series  the series (<code>null</code> not permitted).
         */
        public void addSeries(XYSeries series) {

            if (series == null) {
                throw new IllegalArgumentException("Null 'series' argument.");
            }
            this.data.add(series);
            series.addChangeListener(this);
            fireDatasetChanged();

        }

        /**
         * Removes a series from the collection and sends a
         * {@link DatasetChangeEvent} to all registered listeners.
         *
         * @param series  the series index (zero-based).
         */
        public void removeSeries(int series) {

            if ((series < 0) || (series >= getSeriesCount())) {
                throw new IllegalArgumentException("Series index out of bounds.");
            }

            // fetch the series, remove the change listener, then remove the series.
            XYSeries ts = (XYSeries) this.data.get(series);
            ts.removeChangeListener(this);
            this.data.remove(series);
            fireDatasetChanged();

        }

        /**
         * Removes a series from the collection and sends a
         * {@link DatasetChangeEvent} to all registered listeners.
         *
         * @param series  the series (<code>null</code> not permitted).
         */
        public void removeSeries(XYSeries series) {

            if (series == null) {
                throw new IllegalArgumentException("Null 'series' argument.");
            }
            if (this.data.contains(series)) {
                series.removeChangeListener(this);
                this.data.remove(series);
                fireDatasetChanged();
            }

        }

        /**
         * Removes all the series from the collection and sends a
         * {@link DatasetChangeEvent} to all registered listeners.
         */
        public void removeAllSeries() {
            // Unregister the collection as a change listener to each series in
            // the collection.
            for (int i = 0; i < this.data.size(); i++) {
              XYSeries series = (XYSeries) this.data.get(i);
              series.removeChangeListener(this);
            }

            // Remove all the series from the collection and notify listeners.
            this.data.clear();
            fireDatasetChanged();
        }

        /**
         * Returns the number of series in the collection.
         *
         * @return The series count.
         */
        public int getSeriesCount() {
            return this.data.size();
        }

        /**
         * Returns a list of all the series in the collection.
         *
         * @return The list (which is unmodifiable).
         */
        public List getSeries() {
            return Collections.unmodifiableList(this.data);
        }

        /**
         * Returns the index of the specified series, or -1 if that series is not
         * present in the dataset.
         *
         * @param series  the series (<code>null</code> not permitted).
         *
         * @return The series index.
         *
         * @since 1.0.6
         */
        public int indexOf(XYSeries series) {
            if (series == null) {
                throw new IllegalArgumentException("Null 'series' argument.");
            }
            return this.data.indexOf(series);
        }

        /**
         * Returns a series from the collection.
         *
         * @param series  the series index (zero-based).
         *
         * @return The series.
         *
         * @throws IllegalArgumentException if <code>series</code> is not in the
         *     range <code>0</code> to <code>getSeriesCount() - 1</code>.
         */
        public XYSeries getSeries(int series) {
            if ((series < 0) || (series >= getSeriesCount())) {
                throw new IllegalArgumentException("Series index out of bounds");
            }
            return (XYSeries) this.data.get(series);
        }

        /**
         * Returns a series from the collection.
         *
         * @param key  the key (<code>null</code> not permitted).
         *
         * @return The series with the specified key.
         *
         * @throws UnknownKeyException if <code>key</code> is not found in the
         *         collection.
         *
         * @since 1.0.9
         */
        public XYSeries getSeries(Comparable key) {
            if (key == null) {
                throw new IllegalArgumentException("Null 'key' argument.");
            }
            Iterator iterator = this.data.iterator();
            while (iterator.hasNext()) {
                XYSeries series = (XYSeries) iterator.next();
                if (key.equals(series.getKey())) {
                    return series;
                }
            }
            throw new UnknownKeyException("Key not found: " + key);
        }

        /**
         * Returns the key for a series.
         *
         * @param series  the series index (in the range <code>0</code> to
         *     <code>getSeriesCount() - 1</code>).
         *
         * @return The key for a series.
         *
         * @throws IllegalArgumentException if <code>series</code> is not in the
         *     specified range.
         */
        public Comparable getSeriesKey(int series) {
            // defer argument checking
            return getSeries(series).getKey();
        }

        /**
         * Returns the number of items in the specified series.
         *
         * @param series  the series (zero-based index).
         *
         * @return The item count.
         *
         * @throws IllegalArgumentException if <code>series</code> is not in the
         *     range <code>0</code> to <code>getSeriesCount() - 1</code>.
         */
        public int getItemCount(int series) {
            // defer argument checking
            return getSeries(series).getItemCount();
        }

        /**
         * Returns the x-value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param item  the item (zero-based index).
         *
         * @return The value.
         */
        public Number getX(int series, int item) {
            XYSeries ts = (XYSeries) this.data.get(series);
            XYDataItem xyItem = ts.getDataItem(item);
            return xyItem.getX();
        }

        /**
         * Returns the starting X value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param item  the item (zero-based index).
         *
         * @return The starting X value.
         */
        public Number getStartX(int series, int item) {
            return this.intervalDelegate.getStartX(series, item);
        }

        /**
         * Returns the ending X value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param item  the item (zero-based index).
         *
         * @return The ending X value.
         */
        public Number getEndX(int series, int item) {
            return this.intervalDelegate.getEndX(series, item);
        }

        /**
         * Returns the y-value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param index  the index of the item of interest (zero-based).
         *
         * @return The value (possibly <code>null</code>).
         */
        public Number getY(int series, int index) {

            XYSeries ts = (XYSeries) this.data.get(series);
            XYDataItem xyItem = ts.getDataItem(index);
            return xyItem.getY();

        }

        /**
         * Returns the starting Y value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param item  the item (zero-based index).
         *
         * @return The starting Y value.
         */
        public Number getStartY(int series, int item) {
            return getY(series, item);
        }

        /**
         * Returns the ending Y value for the specified series and item.
         *
         * @param series  the series (zero-based index).
         * @param item  the item (zero-based index).
         *
         * @return The ending Y value.
         */
        public Number getEndY(int series, int item) {
            return getY(series, item);
        }

        /**
         * Tests this collection for equality with an arbitrary object.
         *
         * @param obj  the object (<code>null</code> permitted).
         *
         * @return A boolean.
         */
        public boolean equals(Object obj) {
            /*
             * XXX
             *
             * what about  the interval delegate...?
             * The interval width etc wasn't considered
             * before, hence i did not add it here (AS)
             *
             */

            if (obj == this) {
                return true;
            }
            if (!(obj instanceof XYSeriesCollection)) {
                return false;
            }
            XYSeriesCollection that = (XYSeriesCollection) obj;
            return ObjectUtilities.equal(this.data, that.data);
        }

        /**
         * Returns a clone of this instance.
         *
         * @return A clone.
         *
         * @throws CloneNotSupportedException if there is a problem.
         */
        public Object clone() throws CloneNotSupportedException {
            XYSeriesCollection clone = (XYSeriesCollection) super.clone();
            clone.data = (List) ObjectUtilities.deepClone(this.data);
            clone.intervalDelegate
                    = (IntervalXYDelegate) this.intervalDelegate.clone();
            return clone;
        }

        /**
         * Returns a hash code.
         *
         * @return A hash code.
         */
        public int hashCode() {
            // Same question as for equals (AS)
            return (this.data != null ? this.data.hashCode() : 0);
        }

        /**
         * Returns the minimum x-value in the dataset.
         *
         * @param includeInterval  a flag that determines whether or not the
         *                         x-interval is taken into account.
         *
         * @return The minimum value.
         */
        public double getDomainLowerBound(boolean includeInterval) {
            return this.intervalDelegate.getDomainLowerBound(includeInterval);
        }

        /**
         * Returns the maximum x-value in the dataset.
         *
         * @param includeInterval  a flag that determines whether or not the
         *                         x-interval is taken into account.
         *
         * @return The maximum value.
         */
        public double getDomainUpperBound(boolean includeInterval) {
            return this.intervalDelegate.getDomainUpperBound(includeInterval);
        }

        /**
         * Returns the range of the values in this dataset's domain.
         *
         * @param includeInterval  a flag that determines whether or not the
         *                         x-interval is taken into account.
         *
         * @return The range.
         */
        public Range getDomainBounds(boolean includeInterval) {
            if (includeInterval) {
                return this.intervalDelegate.getDomainBounds(includeInterval);
            }
            else {
                return DatasetUtilities.iterateDomainBounds(this, includeInterval);
            }

        }

        /**
         * Returns the interval width. This is used to calculate the start and end
         * x-values, if/when the dataset is used as an {@link IntervalXYDataset}.
         *
         * @return The interval width.
         */
        public double getIntervalWidth() {
            return this.intervalDelegate.getIntervalWidth();
        }

        /**
         * Sets the interval width and sends a {@link DatasetChangeEvent} to all
         * registered listeners.
         *
         * @param width  the width (negative values not permitted).
         */
        public void setIntervalWidth(double width) {
            if (width < 0.0) {
                throw new IllegalArgumentException("Negative 'width' argument.");
            }
            this.intervalDelegate.setFixedIntervalWidth(width);
            fireDatasetChanged();
        }

        /**
         * Returns the interval position factor.
         *
         * @return The interval position factor.
         */
        public double getIntervalPositionFactor() {
            return this.intervalDelegate.getIntervalPositionFactor();
        }

        /**
         * Sets the interval position factor. This controls where the x-value is in
         * relation to the interval surrounding the x-value (0.0 means the x-value
         * will be positioned at the start, 0.5 in the middle, and 1.0 at the end).
         *
         * @param factor  the factor.
         */
        public void setIntervalPositionFactor(double factor) {
            this.intervalDelegate.setIntervalPositionFactor(factor);
            fireDatasetChanged();
        }

        /**
         * Returns whether the interval width is automatically calculated or not.
         *
         * @return Whether the width is automatically calculated or not.
         */
        public boolean isAutoWidth() {
            return this.intervalDelegate.isAutoWidth();
        }

        /**
         * Sets the flag that indicates wether the interval width is automatically
         * calculated or not.
         *
         * @param b  a boolean.
         */
        public void setAutoWidth(boolean b) {
            this.intervalDelegate.setAutoWidth(b);
            fireDatasetChanged();
        }

    }