content: /* ===========================================================
   * JFreeChart : a free chart library for the Java(tm) platform
   * ===========================================================
   *
   * (C) Copyright 2000-2013, 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.
   *
   * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
   * Other names may be trademarks of their respective owners.]
   *
   * -----------------------
   * XYSeriesCollection.java
   * -----------------------
   * (C) Copyright 2001-2013, 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);
   * 27-Feb-2009 : Overridden getDomainOrder() to detect when all series are
   *               sorted in ascending order (DG);
   * 06-Mar-2009 : Implemented RangeInfo (DG);
   * 06-Mar-2009 : Fixed equals() implementation (DG);
   * 10-Jun-2009 : Simplified code in getX() and getY() methods (DG);
   * 16-Jun-2012 : Removed JCommon dependencies (DG);
   *
   */
  
  package org.jfree.data.xy;
  
  import java.beans.PropertyChangeEvent;
  import java.beans.PropertyVetoException;
  import java.beans.VetoableChangeListener;
  import java.io.Serializable;
  import java.util.Collections;
  import java.util.List;
  
  import org.jfree.chart.HashUtilities;
  import org.jfree.chart.util.ObjectUtilities;
  import org.jfree.chart.util.PublicCloneable;
  import org.jfree.chart.util.ParamChecks;
  import org.jfree.data.DomainInfo;
  import org.jfree.data.DomainOrder;
  import org.jfree.data.Range;
  import org.jfree.data.RangeInfo;
  import org.jfree.data.UnknownKeyException;
  import org.jfree.data.general.DatasetChangeEvent;
  import org.jfree.data.general.Series;
  
  /**
   * Represents a collection of {@link XYSeries} objects that can be used as a
   * dataset.
   */
  public class XYSeriesCollection extends AbstractIntervalXYDataset
          implements IntervalXYDataset, DomainInfo, RangeInfo, 
          VetoableChangeListener, PublicCloneable, Serializable {
  
      /** For serialization. */
      private static final long serialVersionUID = -7590013825931496766L;
  
      /** The series that are included in the collection. */
      private List<XYSeries> 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<XYSeries>();
          this.intervalDelegate = new IntervalXYDelegate(this, false);
          addChangeListener(this.intervalDelegate);
          if (series != null) {
              this.data.add(series);
              series.addChangeListener(this);
              series.addVetoableChangeListener(this);
          }
      }
  
      /**
       * Returns the order of the domain (X) values, if this is known.
       *
       * @return The domain order.
       */
      @Override
      public DomainOrder getDomainOrder() {
          int seriesCount = getSeriesCount();
          for (int i = 0; i < seriesCount; i++) {
              XYSeries s = getSeries(i);
              if (!s.getAutoSort()) {
                  return DomainOrder.NONE;  // we can't be sure of the order
              }
          }
          return DomainOrder.ASCENDING;
      }
  
      /**
       * Adds a series to the collection and sends a {@link DatasetChangeEvent}
       * to all registered listeners.
       *
       * @param series  the series (<code>null</code> not permitted).
       * 
       * @throws IllegalArgumentException if the key for the series is null or
       *     not unique within the dataset.
       */
      public void addSeries(XYSeries series) {
          ParamChecks.nullNotPermitted(series, "series");
          if (getSeriesIndex(series.getKey()) >= 0) {
              throw new IllegalArgumentException(
                  "This dataset already contains a series with the key " 
                  + series.getKey());
          }
          this.data.add(series);
          series.addChangeListener(this);
          series.addVetoableChangeListener(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.");
          }
          XYSeries s = this.data.get(series);
          if (s != null) {
              removeSeries(s);
          }
      }
  
      /**
       * 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) {
          ParamChecks.nullNotPermitted(series, "series");
          if (this.data.contains(series)) {
              series.removeChangeListener(this);
              series.removeVetoableChangeListener(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 (XYSeries series : this.data) {
            series.removeChangeListener(this);
            series.removeVetoableChangeListener(this);
          }
          this.data.clear();
          fireDatasetChanged();
      }
  
      /**
       * Returns the number of series in the collection.
       *
       * @return The series count.
       */
      @Override
      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<XYSeries> 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) {
          ParamChecks.nullNotPermitted(series, "series");
          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 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) {
          ParamChecks.nullNotPermitted(key, "key");
          for (XYSeries series: this.data) {
              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.
       */
      @Override
      public Comparable getSeriesKey(int series) {
          // defer argument checking
          return getSeries(series).getKey();
      }
  
      /**
       * Returns the index of the series with the specified key, or -1 if no
       * series has that key.
       * 
       * @param key  the key (<code>null</code> not permitted).
       * 
       * @return The index.
       * 
       * @since 1.0.14
       */
      public int getSeriesIndex(Comparable key) {
          ParamChecks.nullNotPermitted(key, "key");
          int seriesCount = getSeriesCount();
          for (int i = 0; i < seriesCount; i++) {
              XYSeries series = this.data.get(i);
              if (key.equals(series.getKey())) {
                  return i;
              }
          }
          return -1;
      }
  
      /**
       * 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>.
       */
      @Override
      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.
       */
      @Override
      public Number getX(int series, int item) {
          XYSeries s = this.data.get(series);
          return s.getX(item);
      }
  
      /**
       * 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.
       */
      @Override
      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.
       */
      @Override
      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>).
       */
      @Override
      public Number getY(int series, int index) {
          XYSeries s = this.data.get(series);
          return s.getY(index);
      }
  
      /**
       * 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.
       */
      @Override
      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.
       */
      @Override
      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.
       */
      @Override
      public boolean equals(Object obj) {
          if (obj == this) {
              return true;
          }
          if (!(obj instanceof XYSeriesCollection)) {
              return false;
          }
          XYSeriesCollection that = (XYSeriesCollection) obj;
          if (!this.intervalDelegate.equals(that.intervalDelegate)) {
              return false;
          }
          return ObjectUtilities.equal(this.data, that.data);
      }
  
      /**
       * Returns a clone of this instance.
       *
       * @return A clone.
       *
       * @throws CloneNotSupportedException if there is a problem.
       */
      @Override
      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.
       */
      @Override
      public int hashCode() {
          int hash = 5;
          hash = HashUtilities.hashCode(hash, this.intervalDelegate);
          hash = HashUtilities.hashCode(hash, this.data);
          return hash;
      }
  
      /**
       * 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.
       */
      @Override
      public double getDomainLowerBound(boolean includeInterval) {
          if (includeInterval) {
              return this.intervalDelegate.getDomainLowerBound(includeInterval);
          }
          double result = Double.NaN;
          int seriesCount = getSeriesCount();
          for (int s = 0; s < seriesCount; s++) {
              XYSeries series = getSeries(s);
              double lowX = series.getMinX();
              if (Double.isNaN(result)) {
                  result = lowX;
              }
              else {
                  if (!Double.isNaN(lowX)) {
                      result = Math.min(result, lowX);
                  }
              }
          }
          return result;
      }
  
      /**
       * 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.
       */
      @Override
      public double getDomainUpperBound(boolean includeInterval) {
          if (includeInterval) {
              return this.intervalDelegate.getDomainUpperBound(includeInterval);
          }
          else {
              double result = Double.NaN;
              int seriesCount = getSeriesCount();
              for (int s = 0; s < seriesCount; s++) {
                  XYSeries series = getSeries(s);
                  double hiX = series.getMaxX();
                  if (Double.isNaN(result)) {
                      result = hiX;
                  }
                  else {
                      if (!Double.isNaN(hiX)) {
                          result = Math.max(result, hiX);
                      }
                  }
              }
              return result;
          }
      }
  
      /**
       * 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 (or <code>null</code> if the dataset contains no
       *     values).
       */
      @Override
      public Range getDomainBounds(boolean includeInterval) {
          if (includeInterval) {
              return this.intervalDelegate.getDomainBounds(includeInterval);
          }
          else {
              double lower = Double.POSITIVE_INFINITY;
              double upper = Double.NEGATIVE_INFINITY;
              int seriesCount = getSeriesCount();
              for (int s = 0; s < seriesCount; s++) {
                  XYSeries series = getSeries(s);
                  double minX = series.getMinX();
                  if (!Double.isNaN(minX)) {
                      lower = Math.min(lower, minX);
                  }
                  double maxX = series.getMaxX();
                  if (!Double.isNaN(maxX)) {
                      upper = Math.max(upper, maxX);
                  }
              }
              if (lower > upper) {
                  return null;
              }
              else {
                  return new Range(lower, upper);
              }
          }
      }
  
      /**
       * 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 whether the interval width is automatically
       * calculated or not.
       *
       * @param b  a boolean.
       */
      public void setAutoWidth(boolean b) {
          this.intervalDelegate.setAutoWidth(b);
          fireDatasetChanged();
      }
  
      /**
       * Returns the range of the values in this dataset's range.
       *
       * @param includeInterval  ignored.
       *
       * @return The range (or <code>null</code> if the dataset contains no
       *     values).
       */
      @Override
      public Range getRangeBounds(boolean includeInterval) {
          double lower = Double.POSITIVE_INFINITY;
          double upper = Double.NEGATIVE_INFINITY;
          int seriesCount = getSeriesCount();
          for (int s = 0; s < seriesCount; s++) {
              XYSeries series = getSeries(s);
              double minY = series.getMinY();
              if (!Double.isNaN(minY)) {
                  lower = Math.min(lower, minY);
              }
              double maxY = series.getMaxY();
              if (!Double.isNaN(maxY)) {
                  upper = Math.max(upper, maxY);
              }
          }
          if (lower > upper) {
              return null;
          }
          else {
              return new Range(lower, upper);
          }
      }
  
      /**
       * Returns the minimum y-value in the dataset.
       *
       * @param includeInterval  a flag that determines whether or not the
       *                         y-interval is taken into account.
       *
       * @return The minimum value.
       */
      @Override
      public double getRangeLowerBound(boolean includeInterval) {
          double result = Double.NaN;
          int seriesCount = getSeriesCount();
          for (int s = 0; s < seriesCount; s++) {
              XYSeries series = getSeries(s);
              double lowY = series.getMinY();
              if (Double.isNaN(result)) {
                  result = lowY;
              }
              else {
                  if (!Double.isNaN(lowY)) {
                      result = Math.min(result, lowY);
                  }
              }
          }
          return result;
      }
  
      /**
       * Returns the maximum y-value in the dataset.
       *
       * @param includeInterval  a flag that determines whether or not the
       *                         y-interval is taken into account.
       *
       * @return The maximum value.
       */
      @Override
      public double getRangeUpperBound(boolean includeInterval) {
          double result = Double.NaN;
          int seriesCount = getSeriesCount();
          for (int s = 0; s < seriesCount; s++) {
              XYSeries series = getSeries(s);
              double hiY = series.getMaxY();
              if (Double.isNaN(result)) {
                  result = hiY;
              }
              else {
                  if (!Double.isNaN(hiY)) {
                      result = Math.max(result, hiY);
                  }
              }
          }
          return result;
      }
  
      /**
       * Receives notification that the key for one of the series in the 
       * collection has changed, and vetos it if the key is already present in 
       * the collection.
       * 
       * @param e  the event.
       * 
       * @since 1.0.14
       */
      @Override
      public void vetoableChange(PropertyChangeEvent e)
              throws PropertyVetoException {
          // if it is not the series name, then we have no interest
          if (!"Key".equals(e.getPropertyName())) {
              return;
          }
          
          // to be defensive, let's check that the source series does in fact
          // belong to this collection
          Series s = (Series) e.getSource();
          if (getSeriesIndex(s.getKey()) == -1) {
              throw new IllegalStateException("Receiving events from a series " +
                      "that does not belong to this collection.");
          }
          // check if the new series name already exists for another series
          Comparable key = (Comparable) e.getNewValue();
          if (getSeriesIndex(key) >= 0) {
              throw new PropertyVetoException("Duplicate key", e);
          }
      }
  
  }
  