/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, 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., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * ------------------------------

 * CombinedDomainXYPlotTests.java

 * ------------------------------

 * (C) Copyright 2003, 2004, by Object Refinery Limited and Contributors.

 *

 * Original Author:  David Gilbert (for Object Refinery Limited);

 * Contributor(s):   -;

 *

 * $Id: CombinedDomainXYPlotTests.java,v 1.1 2004/08/31 14:42:21 mungady Exp $

 *

 * Changes

 * -------

 * 21-Aug-2003 : Version 1 (DG);

 *

 */



package org.jfree.chart.plot.junit;



import java.awt.Font;

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 java.util.List;



import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestSuite;



import org.jfree.chart.annotations.XYTextAnnotation;

import org.jfree.chart.axis.AxisLocation;

import org.jfree.chart.axis.NumberAxis;

import org.jfree.chart.plot.CombinedDomainXYPlot;

import org.jfree.chart.plot.PlotOrientation;

import org.jfree.chart.plot.XYPlot;

import org.jfree.chart.renderer.xy.StandardXYItemRenderer;

import org.jfree.chart.renderer.xy.XYItemRenderer;

import org.jfree.data.xy.XYDataset;

import org.jfree.data.xy.XYSeries;

import org.jfree.data.xy.XYSeriesCollection;



/**

 * Tests for the {@link CombinedDomainXYPlot} class.

 */

public class CombinedDomainXYPlotTests extends TestCase {



    /**

     * Returns the tests as a test suite.

     *

     * @return The test suite.

     */

    public static Test suite() {

        return new TestSuite(CombinedDomainXYPlotTests.class);

    }



    /**

     * Constructs a new set of tests.

     *

     * @param name  the name of the tests.

     */

    public CombinedDomainXYPlotTests(String name) {

        super(name);

    }



    /**

     * Confirm that the constructor will accept a null axis.

     */

    public void testConstructor1() {

        CombinedDomainXYPlot plot = new CombinedDomainXYPlot(null);

        assertEquals(null, plot.getDomainAxis());

    }

    

    /**

     * This is a test to replicate the bug report 987080.

     */

    public void testRemoveSubplot() {

        CombinedDomainXYPlot plot = new CombinedDomainXYPlot();

        XYPlot plot1 = new XYPlot();

        XYPlot plot2 = new XYPlot();

        plot.add(plot1);

        plot.add(plot2);

        // remove plot2, but plot1 is removed instead

        plot.remove(plot2);

        List plots = plot.getSubplots();

        assertTrue(plots.get(0) == plot1);

    }

    

    /**

     * Tests the equals() method.

     */

    public void testEquals() {

        CombinedDomainXYPlot plot1 = createPlot();

        CombinedDomainXYPlot plot2 = createPlot();

        assertTrue(plot1.equals(plot2));    

        assertTrue(plot2.equals(plot1));

    }



    /**

     * Confirm that cloning works.

     */

    public void testCloning() {

        CombinedDomainXYPlot plot1 = createPlot();        

        CombinedDomainXYPlot plot2 = null;

        try {

            plot2 = (CombinedDomainXYPlot) plot1.clone();

        }

        catch (CloneNotSupportedException e) {

            System.err.println("CombinedDomainXYPlotTests.testCloning: failed to clone.");

        }

        assertTrue(plot1 != plot2);

        assertTrue(plot1.getClass() == plot2.getClass());

        assertTrue(plot1.equals(plot2));

    }



    /**

     * Serialize an instance, restore it, and check for equality.

     */

    public void testSerialization() {



        CombinedDomainXYPlot plot1 = createPlot();

        CombinedDomainXYPlot plot2 = null;



        try {

            ByteArrayOutputStream buffer = new ByteArrayOutputStream();

            ObjectOutput out = new ObjectOutputStream(buffer);

            out.writeObject(plot1);

            out.close();



            ObjectInput in = new ObjectInputStream(new ByteArrayInputStream(buffer.toByteArray()));

            plot2 = (CombinedDomainXYPlot) in.readObject();

            in.close();

        }

        catch (Exception e) {

            e.printStackTrace();

        }

        assertEquals(plot1, plot2);



    }

    

    /**

     * Creates a sample dataset.

     *

     * @return Series 1.

     */

    private XYDataset createDataset1() {



        // create dataset 1...

        XYSeries series1 = new XYSeries("Series 1");

        series1.add(10.0, 12353.3);

        series1.add(20.0, 13734.4);

        series1.add(30.0, 14525.3);

        series1.add(40.0, 13984.3);

        series1.add(50.0, 12999.4);

        series1.add(60.0, 14274.3);

        series1.add(70.0, 15943.5);

        series1.add(80.0, 14845.3);

        series1.add(90.0, 14645.4);

        series1.add(100.0, 16234.6);

        series1.add(110.0, 17232.3);

        series1.add(120.0, 14232.2);

        series1.add(130.0, 13102.2);

        series1.add(140.0, 14230.2);

        series1.add(150.0, 11235.2);



        XYSeries series2 = new XYSeries("Series 2");

        series2.add(10.0, 15000.3);

        series2.add(20.0, 11000.4);

        series2.add(30.0, 17000.3);

        series2.add(40.0, 15000.3);

        series2.add(50.0, 14000.4);

        series2.add(60.0, 12000.3);

        series2.add(70.0, 11000.5);

        series2.add(80.0, 12000.3);

        series2.add(90.0, 13000.4);

        series2.add(100.0, 12000.6);

        series2.add(110.0, 13000.3);

        series2.add(120.0, 17000.2);

        series2.add(130.0, 18000.2);

        series2.add(140.0, 16000.2);

        series2.add(150.0, 17000.2);



        XYSeriesCollection collection = new XYSeriesCollection();

        collection.addSeries(series1);

        collection.addSeries(series2);

        return collection;



    }



    /**

     * Creates a sample dataset.

     *

     * @return Series 2.

     */

    private XYDataset createDataset2() {



        // create dataset 2...

        XYSeries series2 = new XYSeries("Series 3");



        series2.add(10.0, 16853.2);

        series2.add(20.0, 19642.3);

        series2.add(30.0, 18253.5);

        series2.add(40.0, 15352.3);

        series2.add(50.0, 13532.0);

        series2.add(100.0, 12635.3);

        series2.add(110.0, 13998.2);

        series2.add(120.0, 11943.2);

        series2.add(130.0, 16943.9);

        series2.add(140.0, 17843.2);

        series2.add(150.0, 16495.3);

        series2.add(160.0, 17943.6);

        series2.add(170.0, 18500.7);

        series2.add(180.0, 19595.9);



        return new XYSeriesCollection(series2);



    }



    /**

     * Creates a sample plot.

     * 

     * @return A sample plot.

     */

    private CombinedDomainXYPlot createPlot() {

        // create subplot 1...

        XYDataset data1 = createDataset1();

        XYItemRenderer renderer1 = new StandardXYItemRenderer();

        NumberAxis rangeAxis1 = new NumberAxis("Range 1");

        XYPlot subplot1 = new XYPlot(data1, null, rangeAxis1, renderer1);

        subplot1.setRangeAxisLocation(AxisLocation.BOTTOM_OR_LEFT);

        

        XYTextAnnotation annotation = new XYTextAnnotation("Hello!", 50.0, 10000.0);

        annotation.setFont(new Font("SansSerif", Font.PLAIN, 9));

        annotation.setRotationAngle(Math.PI / 4.0);

        subplot1.addAnnotation(annotation);

        

        // create subplot 2...

        XYDataset data2 = createDataset2();

        XYItemRenderer renderer2 = new StandardXYItemRenderer();

        NumberAxis rangeAxis2 = new NumberAxis("Range 2");

        rangeAxis2.setAutoRangeIncludesZero(false);

        XYPlot subplot2 = new XYPlot(data2, null, rangeAxis2, renderer2);

        subplot2.setRangeAxisLocation(AxisLocation.TOP_OR_LEFT);



        // parent plot...

        CombinedDomainXYPlot plot = new CombinedDomainXYPlot(new NumberAxis("Domain"));

        plot.setGap(10.0);

        

        // add the subplots...

        plot.add(subplot1, 1);

        plot.add(subplot2, 1);

        plot.setOrientation(PlotOrientation.VERTICAL);

        return plot;

    }

}

