jfreechart example source code file (DefaultIntervalXYDataset.java)

This example jfreechart source code file (DefaultIntervalXYDataset.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - jfreechart tags/keywords

clonenotsupportedexception, comparable, datasetchangeevent, defaultintervalxydataset, defaultintervalxydataset, double, double, illegalargumentexception, illegalargumentexception, list, number, number, series, the, util

The jfreechart DefaultIntervalXYDataset.java source code

/* ===========================================================
 * 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.]
 *
 * -----------------------------
 * DefaultIntervalXYDataset.java
 * -----------------------------
 * (C) Copyright 2006-2008, by Object Refinery Limited and Contributors.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * Changes
 * -------
 * 23-Oct-2006 : Version 1 (DG);
 * 02-Nov-2006 : Fixed a problem with adding a new series with the same key
 *               as an existing series (see bug 1589392) (DG);
 * 28-Nov-2006 : New override for clone() (DG);
 * 22-Apr-2008 : Implemented PublicCloneable (DG);
 *
 */

package org.jfree.data.xy;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.jfree.data.general.DatasetChangeEvent;
import org.jfree.util.PublicCloneable;

/**
 * A dataset that defines a range (interval) for both the x-values and the
 * y-values.  This implementation uses six arrays to store the x, start-x,
 * end-x, y, start-y and end-y values.
 * <br>

 * An alternative implementation of the {@link IntervalXYDataset} interface
 * is provided by the {@link XYIntervalSeriesCollection} class.
 *
 * @since 1.0.3
 */
public class DefaultIntervalXYDataset extends AbstractIntervalXYDataset
        implements PublicCloneable {

    /**
     * Storage for the series keys.  This list must be kept in sync with the
     * seriesList.
     */
    private List seriesKeys;

    /**
     * Storage for the series in the dataset.  We use a list because the
     * order of the series is significant.  This list must be kept in sync
     * with the seriesKeys list.
     */
    private List seriesList;

    /**
     * Creates a new <code>DefaultIntervalXYDataset instance, initially
     * containing no data.
     */
    public DefaultIntervalXYDataset() {
        this.seriesKeys = new java.util.ArrayList();
        this.seriesList = new java.util.ArrayList();
    }

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

    /**
     * Returns the key for a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     *
     * @return The key for the series.
     *
     * @throws IllegalArgumentException if <code>series is not in the
     *     specified range.
     */
    public Comparable getSeriesKey(int series) {
        if ((series < 0) || (series >= getSeriesCount())) {
            throw new IllegalArgumentException("Series index out of bounds");
        }
        return (Comparable) this.seriesKeys.get(series);
    }

    /**
     * Returns the number of items in the specified series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     *
     * @return The item count.
     *
     * @throws IllegalArgumentException if <code>series is not in the
     *     specified range.
     */
    public int getItemCount(int series) {
        if ((series < 0) || (series >= getSeriesCount())) {
            throw new IllegalArgumentException("Series index out of bounds");
        }
        double[][] seriesArray = (double[][]) this.seriesList.get(series);
        return seriesArray[0].length;
    }

    /**
     * Returns the x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getX(int, int)
     */
    public double getXValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[0][item];
    }

    /**
     * Returns the y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getY(int, int)
     */
    public double getYValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[3][item];
    }

    /**
     * Returns the starting x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The starting x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getStartX(int, int)
     */
    public double getStartXValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[1][item];
    }

    /**
     * Returns the ending x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The ending x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getEndX(int, int)
     */
    public double getEndXValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[2][item];
    }

    /**
     * Returns the starting y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The starting y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getStartY(int, int)
     */
    public double getStartYValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[4][item];
    }

    /**
     * Returns the ending y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The ending y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getEndY(int, int)
     */
    public double getEndYValue(int series, int item) {
        double[][] seriesData = (double[][]) this.seriesList.get(series);
        return seriesData[5][item];
    }

    /**
     * Returns the ending x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The ending x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getEndXValue(int, int)
     */
    public Number getEndX(int series, int item) {
        return new Double(getEndXValue(series, item));
    }

    /**
     * Returns the ending y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The ending y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getEndYValue(int, int)
     */
    public Number getEndY(int series, int item) {
        return new Double(getEndYValue(series, item));
    }

    /**
     * Returns the starting x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The starting x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getStartXValue(int, int)
     */
    public Number getStartX(int series, int item) {
        return new Double(getStartXValue(series, item));
    }

    /**
     * Returns the starting y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The starting y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getStartYValue(int, int)
     */
    public Number getStartY(int series, int item) {
        return new Double(getStartYValue(series, item));
    }

    /**
     * Returns the x-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The x-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getXValue(int, int)
     */
    public Number getX(int series, int item) {
        return new Double(getXValue(series, item));
    }

    /**
     * Returns the y-value for an item within a series.
     *
     * @param series  the series index (in the range <code>0 to
     *     <code>getSeriesCount() - 1).
     * @param item  the item index (in the range <code>0 to
     *     <code>getItemCount(series)).
     *
     * @return The y-value.
     *
     * @throws ArrayIndexOutOfBoundsException if <code>series is not
     *     within the specified range.
     * @throws ArrayIndexOutOfBoundsException if <code>item is not
     *     within the specified range.
     *
     * @see #getYValue(int, int)
     */
    public Number getY(int series, int item) {
        return new Double(getYValue(series, item));
    }

    /**
     * Adds a series or if a series with the same key already exists replaces
     * the data for that series, then sends a {@link DatasetChangeEvent} to
     * all registered listeners.
     *
     * @param seriesKey  the series key (<code>null not permitted).
     * @param data  the data (must be an array with length 6, containing six
     *     arrays of equal length, the first containing the x-values and the
     *     second containing the y-values).
     */
    public void addSeries(Comparable seriesKey, double[][] data) {
        if (seriesKey == null) {
            throw new IllegalArgumentException(
                    "The 'seriesKey' cannot be null.");
        }
        if (data == null) {
            throw new IllegalArgumentException("The 'data' is null.");
        }
        if (data.length != 6) {
            throw new IllegalArgumentException(
                    "The 'data' array must have length == 6.");
        }
        int length = data[0].length;
        if (length != data[1].length || length != data[2].length
                || length != data[3].length || length != data[4].length
                || length != data[5].length) {
            throw new IllegalArgumentException(
                "The 'data' array must contain two arrays with equal length.");
        }
        int seriesIndex = indexOf(seriesKey);
        if (seriesIndex == -1) {  // add a new series
            this.seriesKeys.add(seriesKey);
            this.seriesList.add(data);
        }
        else {  // replace an existing series
            this.seriesList.remove(seriesIndex);
            this.seriesList.add(seriesIndex, data);
        }
        notifyListeners(new DatasetChangeEvent(this, this));
    }

    /**
     * Tests this <code>DefaultIntervalXYDataset instance for equality
     * with an arbitrary object.  This method returns <code>true if and
     * only if:
     * <ul>
     * <li>obj is not null;
     * <li>obj is an instance of
     *         <code>DefaultIntervalXYDataset;
     * <li>both datasets have the same number of series, each containing
     *         exactly the same values.</li>
     * </ul>
     *
     * @param obj  the object (<code>null permitted).
     *
     * @return A boolean.
     */
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof DefaultIntervalXYDataset)) {
            return false;
        }
        DefaultIntervalXYDataset that = (DefaultIntervalXYDataset) obj;
        if (!this.seriesKeys.equals(that.seriesKeys)) {
            return false;
        }
        for (int i = 0; i < this.seriesList.size(); i++) {
            double[][] d1 = (double[][]) this.seriesList.get(i);
            double[][] d2 = (double[][]) that.seriesList.get(i);
            double[] d1x = d1[0];
            double[] d2x = d2[0];
            if (!Arrays.equals(d1x, d2x)) {
                return false;
            }
            double[] d1xs = d1[1];
            double[] d2xs = d2[1];
            if (!Arrays.equals(d1xs, d2xs)) {
                return false;
            }
            double[] d1xe = d1[2];
            double[] d2xe = d2[2];
            if (!Arrays.equals(d1xe, d2xe)) {
                return false;
            }
            double[] d1y = d1[3];
            double[] d2y = d2[3];
            if (!Arrays.equals(d1y, d2y)) {
                return false;
            }
            double[] d1ys = d1[4];
            double[] d2ys = d2[4];
            if (!Arrays.equals(d1ys, d2ys)) {
                return false;
            }
            double[] d1ye = d1[5];
            double[] d2ye = d2[5];
            if (!Arrays.equals(d1ye, d2ye)) {
                return false;
            }
        }
        return true;
    }

    /**
     * Returns a hash code for this instance.
     *
     * @return A hash code.
     */
    public int hashCode() {
        int result;
        result = this.seriesKeys.hashCode();
        result = 29 * result + this.seriesList.hashCode();
        return result;
    }

    /**
     * Returns a clone of this dataset.
     *
     * @return A clone.
     *
     * @throws CloneNotSupportedException if the dataset contains a series with
     *         a key that cannot be cloned.
     */
    public Object clone() throws CloneNotSupportedException {
        DefaultIntervalXYDataset clone
                = (DefaultIntervalXYDataset) super.clone();
        clone.seriesKeys = new java.util.ArrayList(this.seriesKeys);
        clone.seriesList = new ArrayList(this.seriesList.size());
        for (int i = 0; i < this.seriesList.size(); i++) {
            double[][] data = (double[][]) this.seriesList.get(i);
            double[] x = data[0];
            double[] xStart = data[1];
            double[] xEnd = data[2];
            double[] y = data[3];
            double[] yStart = data[4];
            double[] yEnd = data[5];
            double[] xx = new double[x.length];
            double[] xxStart = new double[xStart.length];
            double[] xxEnd = new double[xEnd.length];
            double[] yy = new double[y.length];
            double[] yyStart = new double[yStart.length];
            double[] yyEnd = new double[yEnd.length];
            System.arraycopy(x, 0, xx, 0, x.length);
            System.arraycopy(xStart, 0, xxStart, 0, xStart.length);
            System.arraycopy(xEnd, 0, xxEnd, 0, xEnd.length);
            System.arraycopy(y, 0, yy, 0, y.length);
            System.arraycopy(yStart, 0, yyStart, 0, yStart.length);
            System.arraycopy(yEnd, 0, yyEnd, 0, yEnd.length);
            clone.seriesList.add(i, new double[][] {xx, xxStart, xxEnd, yy,
                    yyStart, yyEnd});
        }
        return clone;
    }

}