# XYLineAndShapeRendererTests.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.]
     *
     * --------------------------------
     * XYLineAndShapeRendererTests.java
     * --------------------------------
     * (C) Copyright 2004-2008, by Object Refinery Limited and Contributors.
     *
     * Original Author:  David Gilbert (for Object Refinery Limited);
     * Contributor(s):   -;
     *
     * Changes
     * -------
     * 27-Jan-2004 : Version 1 (DG);
     * 07-Jan-2005 : Added check for findRangeBounds() method (DG);
     * 21-Feb-2007 : Check independence in testCloning() (DG);
     * 17-May-2007 : Added testGetLegendItemSeriesIndex() (DG);
     * 22-Apr-2008 : Added testPublicCloneable() (DG);
     *
     */

    package org.jfree.chart.renderer.xy.junit;

    import java.awt.geom.Line2D;
    import java.awt.geom.Rectangle2D;
    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.chart.ChartFactory;
    import org.jfree.chart.JFreeChart;
    import org.jfree.chart.LegendItem;
    import org.jfree.chart.axis.NumberAxis;
    import org.jfree.chart.plot.PlotOrientation;
    import org.jfree.chart.plot.XYPlot;
    import org.jfree.chart.renderer.xy.XYLineAndShapeRenderer;
    import org.jfree.chart.urls.TimeSeriesURLGenerator;
    import org.jfree.data.Range;
    import org.jfree.data.xy.TableXYDataset;
    import org.jfree.data.xy.XYSeries;
    import org.jfree.data.xy.XYSeriesCollection;
    import org.jfree.util.PublicCloneable;

    /**
     * Tests for the {@link XYLineAndShapeRenderer} class.
     */
    public class XYLineAndShapeRendererTests extends TestCase {

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

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

        /**
         * Test that the equals() method distinguishes all fields.
         */
        public void testEquals() {

            XYLineAndShapeRenderer r1 = new XYLineAndShapeRenderer();
            XYLineAndShapeRenderer r2 = new XYLineAndShapeRenderer();
            assertEquals(r1, r2);
            assertEquals(r2, r1);

            r1.setLinesVisible(true);
            assertFalse(r1.equals(r2));
            r2.setLinesVisible(true);
            assertTrue(r1.equals(r2));

            r1.setSeriesLinesVisible(3, true);
            assertFalse(r1.equals(r2));
            r2.setSeriesLinesVisible(3, true);
            assertTrue(r1.equals(r2));

            r1.setBaseLinesVisible(false);
            assertFalse(r1.equals(r2));
            r2.setBaseLinesVisible(false);
            assertTrue(r1.equals(r2));

            r1.setLegendLine(new Line2D.Double(1.0, 2.0, 3.0, 4.0));
            assertFalse(r1.equals(r2));
            r2.setLegendLine(new Line2D.Double(1.0, 2.0, 3.0, 4.0));
            assertTrue(r1.equals(r2));

            r1.setShapesVisible(true);
            assertFalse(r1.equals(r2));
            r2.setShapesVisible(true);
            assertTrue(r1.equals(r2));

            r1.setSeriesShapesVisible(3, true);
            assertFalse(r1.equals(r2));
            r2.setSeriesShapesVisible(3, true);
            assertTrue(r1.equals(r2));

            r1.setBaseShapesVisible(false);
            assertFalse(r1.equals(r2));
            r2.setBaseShapesVisible(false);
            assertTrue(r1.equals(r2));

            r1.setShapesFilled(true);
            assertFalse(r1.equals(r2));
            r2.setShapesFilled(true);
            assertTrue(r1.equals(r2));

            r1.setSeriesShapesFilled(3, true);
            assertFalse(r1.equals(r2));
            r2.setSeriesShapesFilled(3, true);
            assertTrue(r1.equals(r2));

            r1.setBaseShapesFilled(false);
            assertFalse(r1.equals(r2));
            r2.setBaseShapesFilled(false);
            assertTrue(r1.equals(r2));

            r1.setDrawOutlines(!r1.getDrawOutlines());
            assertFalse(r1.equals(r2));
            r2.setDrawOutlines(r1.getDrawOutlines());
            assertTrue(r1.equals(r2));

            r1.setUseOutlinePaint(true);
            assertFalse(r1.equals(r2));
            r2.setUseOutlinePaint(true);
            assertTrue(r1.equals(r2));

            r1.setUseFillPaint(true);
            assertFalse(r1.equals(r2));
            r2.setUseFillPaint(true);
            assertTrue(r1.equals(r2));

            r1.setDrawSeriesLineAsPath(true);
            assertFalse(r1.equals(r2));
            r2.setDrawSeriesLineAsPath(true);
            assertTrue(r1.equals(r2));
        }

        /**
         * Test that the equals() method works for a TimeSeriesURLGenerator.
         */
        public void testEquals2() {
            XYLineAndShapeRenderer r1 = new XYLineAndShapeRenderer();
            XYLineAndShapeRenderer r2 = new XYLineAndShapeRenderer();
            assertEquals(r1, r2);
            assertEquals(r2, r1);

            r1.setURLGenerator(new TimeSeriesURLGenerator());
            assertFalse(r1.equals(r2));
            r2.setURLGenerator(new TimeSeriesURLGenerator());
            assertTrue(r1.equals(r2));
        }

        /**
         * Two objects that are equal are required to return the same hashCode.
         */
        public void testHashcode() {
            XYLineAndShapeRenderer r1 = new XYLineAndShapeRenderer();
            XYLineAndShapeRenderer r2 = new XYLineAndShapeRenderer();
            assertTrue(r1.equals(r2));
            int h1 = r1.hashCode();
            int h2 = r2.hashCode();
            assertEquals(h1, h2);
        }

        /**
         * Confirm that cloning works.
         */
        public void testCloning() {
            Rectangle2D legendShape = new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0);
            XYLineAndShapeRenderer r1 = new XYLineAndShapeRenderer();
            r1.setLegendLine(legendShape);
            XYLineAndShapeRenderer r2 = null;
            try {
                r2 = (XYLineAndShapeRenderer) r1.clone();
            }
            catch (CloneNotSupportedException e) {
                e.printStackTrace();
            }
            assertTrue(r1 != r2);
            assertTrue(r1.getClass() == r2.getClass());
            assertTrue(r1.equals(r2));

            r1.setSeriesLinesVisible(0, false);
            assertFalse(r1.equals(r2));
            r2.setSeriesLinesVisible(0, false);
            assertTrue(r1.equals(r2));

            legendShape.setRect(4.0, 3.0, 2.0, 1.0);
            assertFalse(r1.equals(r2));
            r2.setLegendLine(new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0));
            assertTrue(r1.equals(r2));

            r1.setSeriesShapesVisible(1, true);
            assertFalse(r1.equals(r2));
            r2.setSeriesShapesVisible(1, true);
            assertTrue(r1.equals(r2));

            r1.setSeriesShapesFilled(1, true);
            assertFalse(r1.equals(r2));
            r2.setSeriesShapesFilled(1, true);
            assertTrue(r1.equals(r2));
        }

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

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

            XYLineAndShapeRenderer r1 = new XYLineAndShapeRenderer();
            XYLineAndShapeRenderer r2 = null;
            try {
                ByteArrayOutputStream buffer = new ByteArrayOutputStream();
                ObjectOutput out = new ObjectOutputStream(buffer);
                out.writeObject(r1);
                out.close();

                ObjectInput in = new ObjectInputStream(
                        new ByteArrayInputStream(buffer.toByteArray()));
                r2 = (XYLineAndShapeRenderer) in.readObject();
                in.close();
            }
            catch (Exception e) {
                e.printStackTrace();
            }
            assertEquals(r1, r2);

        }

        /**
         * Check that the renderer is calculating the domain bounds correctly.
         */
        public void testFindDomainBounds() {
            XYSeriesCollection dataset
                    = RendererXYPackageTests.createTestXYSeriesCollection();
            JFreeChart chart = ChartFactory.createXYLineChart(
                    "Test Chart", "X", "Y", dataset, PlotOrientation.VERTICAL,
                    false, false, false);
            XYPlot plot = (XYPlot) chart.getPlot();
            NumberAxis domainAxis = (NumberAxis) plot.getDomainAxis();
            domainAxis.setAutoRangeIncludesZero(false);
            Range bounds = domainAxis.getRange();
            assertFalse(bounds.contains(0.9));
            assertTrue(bounds.contains(1.0));
            assertTrue(bounds.contains(2.0));
            assertFalse(bounds.contains(2.10));
        }

        /**
         * Check that the renderer is calculating the range bounds correctly.
         */
        public void testFindRangeBounds() {
            TableXYDataset dataset
                    = RendererXYPackageTests.createTestTableXYDataset();
            JFreeChart chart = ChartFactory.createXYLineChart(
                    "Test Chart", "X", "Y", dataset, PlotOrientation.VERTICAL,
                    false, false, false);
            XYPlot plot = (XYPlot) chart.getPlot();
            NumberAxis rangeAxis = (NumberAxis) plot.getRangeAxis();
            rangeAxis.setAutoRangeIncludesZero(false);
            Range bounds = rangeAxis.getRange();
            assertFalse(bounds.contains(1.0));
            assertTrue(bounds.contains(2.0));
            assertTrue(bounds.contains(5.0));
            assertFalse(bounds.contains(6.0));
        }

        /**
         * A check for the datasetIndex and seriesIndex fields in the LegendItem
         * returned by the getLegendItem() method.
         */
        public void testGetLegendItemSeriesIndex() {
            XYSeriesCollection d1 = new XYSeriesCollection();
            XYSeries s1 = new XYSeries("S1");
            s1.add(1.0, 1.1);
            XYSeries s2 = new XYSeries("S2");
            s2.add(1.0, 1.1);
            d1.addSeries(s1);
            d1.addSeries(s2);

            XYSeriesCollection d2 = new XYSeriesCollection();
            XYSeries s3 = new XYSeries("S3");
            s3.add(1.0, 1.1);
            XYSeries s4 = new XYSeries("S4");
            s4.add(1.0, 1.1);
            XYSeries s5 = new XYSeries("S5");
            s5.add(1.0, 1.1);
            d2.addSeries(s3);
            d2.addSeries(s4);
            d2.addSeries(s5);

            XYLineAndShapeRenderer r = new XYLineAndShapeRenderer();
            XYPlot plot = new XYPlot(d1, new NumberAxis("x"),
                    new NumberAxis("y"), r);
            plot.setDataset(1, d2);
            /*JFreeChart chart =*/ new JFreeChart(plot);
            LegendItem li = r.getLegendItem(1, 2);
            assertEquals("S5", li.getLabel());
            assertEquals(1, li.getDatasetIndex());
            assertEquals(2, li.getSeriesIndex());
        }

    }