content: /* ===========================================================
   * JFreeChart : a free chart library for the Java(tm) platform
   * ===========================================================
   *
   * (C) Copyright 2000-2012, 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.]
   *
   * ------------------------------
   * YIntervalSeriesCollection.java
   * ------------------------------
   * (C) Copyright 2006-2012, by Object Refinery Limited.
   *
   * Original Author:  David Gilbert (for Object Refinery Limited);
   * Contributor(s):   -;
   *
   * Changes
   * -------
   * 20-Oct-2006 : Version 1 (DG);
   * 27-Nov-2006 : Added clone() override (DG);
   * 20-Feb-2007 : Added getYValue(), getStartYValue() and getEndYValue()
   *               methods (DG);
   * 18-Jan-2008 : Added removeSeries() and removeAllSeries() methods (DG);
   * 22-Apr-2008 : Implemented PublicCloneable (DG);
   * 16-Jun-2012 : Removed JCommon dependencies (DG);
   *
   */
  
  package org.jfree.data.xy;
  
  import java.io.Serializable;
  import java.util.List;
  
  import org.jfree.chart.util.ObjectUtilities;
  import org.jfree.chart.util.ParamChecks;
  import org.jfree.chart.util.PublicCloneable;
  import org.jfree.data.general.DatasetChangeEvent;
  
  /**
   * A collection of {@link YIntervalSeries} objects.
   *
   * @since 1.0.3
   *
   * @see YIntervalSeries
   */
  public class YIntervalSeriesCollection extends AbstractIntervalXYDataset
          implements IntervalXYDataset, PublicCloneable, Serializable {
  
      /** Storage for the data series. */
      private List<YIntervalSeries> data;
  
      /**
       * Creates a new instance of <code>YIntervalSeriesCollection</code>.
       */
      public YIntervalSeriesCollection() {
          this.data = new java.util.ArrayList<YIntervalSeries>();
      }
  
      /**
       * 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(YIntervalSeries series) {
          ParamChecks.nullNotPermitted(series, "series");
          this.data.add(series);
          series.addChangeListener(this);
          fireDatasetChanged();
      }
  
      /**
       * Returns the number of series in the collection.
       *
       * @return The series count.
       */
      @Override
      public int getSeriesCount() {
          return this.data.size();
      }
  
      /**
       * 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 YIntervalSeries getSeries(int series) {
          if ((series < 0) || (series >= getSeriesCount())) {
              throw new IllegalArgumentException("Series index out of bounds");
          }
          return this.data.get(series);
      }
  
      /**
       * 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 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 an item within a series.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The x-value.
       */
      @Override
      public Number getX(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getX(item);
      }
  
      /**
       * Returns the y-value (as a double primitive) for an item within a
       * series.
       *
       * @param series  the series index (zero-based).
       * @param item  the item index (zero-based).
       *
       * @return The value.
       */
      @Override
      public double getYValue(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYValue(item);
      }
  
      /**
       * Returns the start y-value (as a double primitive) for an item within a
       * series.
       *
       * @param series  the series index (zero-based).
       * @param item  the item index (zero-based).
       *
       * @return The value.
       */
      @Override
      public double getStartYValue(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYLowValue(item);
      }
  
      /**
       * Returns the end y-value (as a double primitive) for an item within a
       * series.
       *
       * @param series  the series (zero-based index).
       * @param item  the item (zero-based index).
       *
       * @return The value.
       */
      @Override
      public double getEndYValue(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYHighValue(item);
      }
  
      /**
       * Returns the y-value for an item within a series.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The y-value.
       */
      @Override
      public Number getY(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYValue(item);
      }
  
      /**
       * Returns the start x-value for an item within a series.  This method
       * maps directly to {@link #getX(int, int)}.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The x-value.
       */
      @Override
      public Number getStartX(int series, int item) {
          return getX(series, item);
      }
  
      /**
       * Returns the end x-value for an item within a series.  This method
       * maps directly to {@link #getX(int, int)}.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The x-value.
       */
      @Override
      public Number getEndX(int series, int item) {
          return getX(series, item);
      }
  
      /**
       * Returns the start y-value for an item within a series.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The start y-value.
       */
      @Override
      public Number getStartY(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYLowValue(item);
      }
  
      /**
       * Returns the end y-value for an item within a series.
       *
       * @param series  the series index.
       * @param item  the item index.
       *
       * @return The end y-value.
       */
      @Override
      public Number getEndY(int series, int item) {
          YIntervalSeries s = this.data.get(series);
          return s.getYHighValue(item);
      }
  
      /**
       * Removes a series from the collection and sends a
       * {@link DatasetChangeEvent} to all registered listeners.
       *
       * @param series  the series index (zero-based).
       *
       * @since 1.0.10
       */
      public void removeSeries(int series) {
          if ((series < 0) || (series >= getSeriesCount())) {
              throw new IllegalArgumentException("Series index out of bounds.");
          }
          YIntervalSeries ts = 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).
       *
       * @since 1.0.10
       */
      public void removeSeries(YIntervalSeries series) {
          ParamChecks.nullNotPermitted(series, "series");
          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.
       *
       * @since 1.0.10
       */
      public void removeAllSeries() {
          // Unregister the collection as a change listener to each series in
          // the collection.
          for (YIntervalSeries series : this.data) {
            series.removeChangeListener(this);
          }
          this.data.clear();
          fireDatasetChanged();
      }
  
      /**
       * Tests this instance 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 YIntervalSeriesCollection)) {
              return false;
          }
          YIntervalSeriesCollection that = (YIntervalSeriesCollection) obj;
          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 {
          YIntervalSeriesCollection clone
                  = (YIntervalSeriesCollection) super.clone();
          clone.data = (List) ObjectUtilities.deepClone(this.data);
          return clone;
      }
  
  }
  