# DefaultXYDatasetTests.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.]
     *
     * --------------------------
     * DefaultXYDatasetTests.java
     * --------------------------
     * (C) Copyright 2006-2008, by Object Refinery Limited and Contributors.
     *
     * Original Author:  David Gilbert (for Object Refinery Limited);
     * Contributor(s):   -;
     *
     * Changes
     * -------
     * 06-Jul-2006 : Version 1 (DG);
     * 02-Nov-2006 : Added testAddSeries() method (DG);
     * 22-Apr-2008 : Added testPublicCloneable (DG);
     *
     */

    package org.jfree.data.xy.junit;

    import java.io.ByteArrayInputStream;
    import java.io.ByteArrayOutputStream;
    import java.io.ObjectInput;
    import java.io.ObjectInputStream;
    import java.io.ObjectOutput;
    import java.io.ObjectOutputStream;

    import junit.framework.Test;
    import junit.framework.TestCase;
    import junit.framework.TestSuite;

    import org.jfree.data.xy.DefaultXYDataset;
    import org.jfree.util.PublicCloneable;

    /**
     * Tests for {@link DefaultXYDataset}.
     */
    public class DefaultXYDatasetTests extends TestCase {

        /**
         * Returns the tests as a test suite.
         *
         * @return The test suite.
         */
        public static Test suite() {
            return new TestSuite(DefaultXYDatasetTests.class);
        }

        /**
         * Constructs a new set of tests.
         *
         * @param name  the name of the tests.
         */
        public DefaultXYDatasetTests(String name) {
            super(name);
        }

        /**
         * Confirm that the equals method can distinguish all the required fields.
         */
        public void testEquals() {

            DefaultXYDataset d1 = new DefaultXYDataset();
            DefaultXYDataset d2 = new DefaultXYDataset();
            assertTrue(d1.equals(d2));
            assertTrue(d2.equals(d1));

            double[] x1 = new double[] {1.0, 2.0, 3.0};
            double[] y1 = new double[] {4.0, 5.0, 6.0};
            double[][] data1 = new double[][] {x1, y1};
            double[] x2 = new double[] {1.0, 2.0, 3.0};
            double[] y2 = new double[] {4.0, 5.0, 6.0};
            double[][] data2 = new double[][] {x2, y2};
            d1.addSeries("S1", data1);
            assertFalse(d1.equals(d2));
            d2.addSeries("S1", data2);
            assertTrue(d1.equals(d2));
        }

        /**
         * Confirm that cloning works.
         */
        public void testCloning() {
            DefaultXYDataset d1 = new DefaultXYDataset();
            DefaultXYDataset d2 = null;
            try {
                d2 = (DefaultXYDataset) d1.clone();
            }
            catch (CloneNotSupportedException e) {
                e.printStackTrace();
            }
            assertTrue(d1 != d2);
            assertTrue(d1.getClass() == d2.getClass());
            assertTrue(d1.equals(d2));

            // try a dataset with some content...
            double[] x1 = new double[] {1.0, 2.0, 3.0};
            double[] y1 = new double[] {4.0, 5.0, 6.0};
            double[][] data1 = new double[][] {x1, y1};
            d1.addSeries("S1", data1);
            try {
                d2 = (DefaultXYDataset) d1.clone();
            }
            catch (CloneNotSupportedException e) {
                e.printStackTrace();
            }
            assertTrue(d1 != d2);
            assertTrue(d1.getClass() == d2.getClass());
            assertTrue(d1.equals(d2));

            // check that the clone doesn't share the same underlying arrays.
            x1[1] = 2.2;
            assertFalse(d1.equals(d2));
            x1[1] = 2.0;
            assertTrue(d1.equals(d2));
        }

        /**
         * Verify that this class implements {@link PublicCloneable}.
         */
        public void testPublicCloneable() {
            DefaultXYDataset d1 = new DefaultXYDataset();
            assertTrue(d1 instanceof PublicCloneable);
        }

        /**
         * Serialize an instance, restore it, and check for equality.
         */
        public void testSerialization() {

            DefaultXYDataset d1 = new DefaultXYDataset();
            DefaultXYDataset d2 = null;

            try {
                ByteArrayOutputStream buffer = new ByteArrayOutputStream();
                ObjectOutput out = new ObjectOutputStream(buffer);
                out.writeObject(d1);
                out.close();

                ObjectInput in = new ObjectInputStream(
                    new ByteArrayInputStream(buffer.toByteArray())
                );
                d2 = (DefaultXYDataset) in.readObject();
                in.close();
            }
            catch (Exception e) {
                e.printStackTrace();
            }
            assertEquals(d1, d2);

            // try a dataset with some content...
            double[] x1 = new double[] {1.0, 2.0, 3.0};
            double[] y1 = new double[] {4.0, 5.0, 6.0};
            double[][] data1 = new double[][] {x1, y1};
            d1.addSeries("S1", data1);
            try {
                ByteArrayOutputStream buffer = new ByteArrayOutputStream();
                ObjectOutput out = new ObjectOutputStream(buffer);
                out.writeObject(d1);
                out.close();

                ObjectInput in = new ObjectInputStream(
                    new ByteArrayInputStream(buffer.toByteArray())
                );
                d2 = (DefaultXYDataset) in.readObject();
                in.close();
            }
            catch (Exception e) {
                e.printStackTrace();
            }
            assertEquals(d1, d2);

        }

        /**
         * Some checks for the getSeriesKey(int) method.
         */
        public void testGetSeriesKey() {
            DefaultXYDataset d = createSampleDataset1();
            assertEquals("S1", d.getSeriesKey(0));
            assertEquals("S2", d.getSeriesKey(1));

            // check for series key out of bounds
            boolean pass = false;
            try {
                /*Comparable k =*/ d.getSeriesKey(-1);
            }
            catch (IllegalArgumentException e) {
                pass = true;
            }
            assertTrue(pass);

            pass = false;
            try {
                /*Comparable k =*/ d.getSeriesKey(2);
            }
            catch (IllegalArgumentException e) {
                pass = true;
            }
            assertTrue(pass);
        }

        /**
         * Some checks for the indexOf(Comparable) method.
         */
        public void testIndexOf() {
            DefaultXYDataset d = createSampleDataset1();
            assertEquals(0, d.indexOf("S1"));
            assertEquals(1, d.indexOf("S2"));
            assertEquals(-1, d.indexOf("Green Eggs and Ham"));
            assertEquals(-1, d.indexOf(null));
        }

        static final double EPSILON = 0.0000000001;

        /**
         * Some tests for the addSeries() method.
         */
        public void testAddSeries() {
            DefaultXYDataset d = new DefaultXYDataset();
            d.addSeries("S1", new double[][] {{1.0}, {2.0}});
            assertEquals(1, d.getSeriesCount());
            assertEquals("S1", d.getSeriesKey(0));

            // check that adding a series will overwrite the old series
            d.addSeries("S1", new double[][] {{11.0}, {12.0}});
            assertEquals(1, d.getSeriesCount());
            assertEquals(12.0, d.getYValue(0, 0), EPSILON);

            // check null key
            boolean pass = false;
            try
            {
              d.addSeries(null, new double[][] {{1.0}, {2.0}});
            }
            catch (IllegalArgumentException e)
            {
              pass = true;
            }
            assertTrue(pass);
        }

        /**
         * Creates a sample dataset for testing.
         *
         * @return A sample dataset.
         */
        public DefaultXYDataset createSampleDataset1() {
            DefaultXYDataset d = new DefaultXYDataset();
            double[] x1 = new double[] {1.0, 2.0, 3.0};
            double[] y1 = new double[] {4.0, 5.0, 6.0};
            double[][] data1 = new double[][] {x1, y1};
            d.addSeries("S1", data1);

            double[] x2 = new double[] {1.0, 2.0, 3.0};
            double[] y2 = new double[] {4.0, 5.0, 6.0};
            double[][] data2 = new double[][] {x2, y2};
            d.addSeries("S2", data2);
            return d;
        }

    }