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

 * 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.]

 *

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

 * NumberAxisTests.java

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

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

 *

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

 * Contributor(s):   -;

 *

 * $Id: NumberAxisTests.java,v 1.1 2004/08/31 14:31:24 mungady Exp $

 *

 * Changes

 * -------

 * 26-Mar-2003 : Version 1 (DG);

 * 14-Aug-2003 : Added tests for equals(...) method (DG);

 *

 */



package org.jfree.chart.axis.junit;



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 java.text.DecimalFormat;



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.axis.NumberAxis;

import org.jfree.chart.axis.NumberTickUnit;

import org.jfree.chart.plot.PlotOrientation;

import org.jfree.data.category.DefaultCategoryDataset;

import org.jfree.ui.RectangleEdge;



/**

 * Tests for the {@link NumberAxis} class.

 */

public class NumberAxisTests extends TestCase {



    /**

     * Returns the tests as a test suite.

     *

     * @return The test suite.

     */

    public static Test suite() {

        return new TestSuite(NumberAxisTests.class);

    }



    /**

     * Constructs a new set of tests.

     *

     * @param name  the name of the tests.

     */

    public NumberAxisTests(String name) {

        super(name);

    }

    

    /**

     * Confirm that cloning works.

     */

    public void testCloning() {

        NumberAxis a1 = new NumberAxis("Test");

        NumberAxis a2 = null;

        try {

            a2 = (NumberAxis) a1.clone();

        }

        catch (CloneNotSupportedException e) {

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

        }

        assertTrue(a1 != a2);

        assertTrue(a1.getClass() == a2.getClass());

        assertTrue(a1.equals(a2));

    }



    /**

     * Confirm that the equals method can distinguish all the required fields.

     */

    public void testEquals() {

        

        NumberAxis a1 = new NumberAxis("Test");

        NumberAxis a2 = new NumberAxis("Test");

        assertTrue(a1.equals(a2));

        

        //private boolean autoRangeIncludesZero;

        a1.setAutoRangeIncludesZero(false);

        assertFalse(a1.equals(a2));

        a2.setAutoRangeIncludesZero(false);

        assertTrue(a1.equals(a2));



        //private boolean autoRangeStickyZero;

        a1.setAutoRangeStickyZero(false);

        assertFalse(a1.equals(a2));

        a2.setAutoRangeStickyZero(false);

        assertTrue(a1.equals(a2));



        //private NumberTickUnit tickUnit;

        a1.setTickUnit(new NumberTickUnit(25.0));

        assertFalse(a1.equals(a2));

        a2.setTickUnit(new NumberTickUnit(25.0));

        assertTrue(a1.equals(a2));



        //private NumberFormat numberFormatOverride;

        a1.setNumberFormatOverride(new DecimalFormat("0.00"));

        assertFalse(a1.equals(a2));

        a2.setNumberFormatOverride(new DecimalFormat("0.00"));

        assertTrue(a1.equals(a2));



        

    }

    

    /**

     * Tests two doubles for 'near enough' equality.

     * 

     * @param d1  number 1.

     * @param d2  number 2.

     * @param tolerance  maximum tolerance.

     * 

     * @return A boolean.

     */

    private boolean same(double d1, double d2, double tolerance) {

        return (Math.abs(d1 - d2) < tolerance);

    }

    

    /**

     * Test the translation of Java2D values to data values.

     */

    public void testTranslateJava2DToValue() {

        NumberAxis axis = new NumberAxis();

        axis.setRange(50.0, 100.0); 

        Rectangle2D dataArea = new Rectangle2D.Double(10.0, 50.0, 400.0, 300.0);

        double y1 = axis.java2DToValue(75.0, dataArea, RectangleEdge.LEFT);  

        assertTrue(same(y1, 95.8333333, 0.000001)); 

        double y2 = axis.java2DToValue(75.0, dataArea, RectangleEdge.RIGHT);   

        assertTrue(same(y2, 95.8333333, 0.000001)); 

        double x1 = axis.java2DToValue(75.0, dataArea, RectangleEdge.TOP);   

        assertTrue(same(x1, 58.125, 0.000001)); 

        double x2 = axis.java2DToValue(75.0, dataArea, RectangleEdge.BOTTOM);   

        assertTrue(same(x2, 58.125, 0.000001)); 

        axis.setInverted(true);

        double y3 = axis.java2DToValue(75.0, dataArea, RectangleEdge.LEFT);  

        assertTrue(same(y3, 54.1666667, 0.000001)); 

        double y4 = axis.java2DToValue(75.0, dataArea, RectangleEdge.RIGHT);   

        assertTrue(same(y4, 54.1666667, 0.000001)); 

        double x3 = axis.java2DToValue(75.0, dataArea, RectangleEdge.TOP);   

        assertTrue(same(x3, 91.875, 0.000001)); 

        double x4 = axis.java2DToValue(75.0, dataArea, RectangleEdge.BOTTOM);   

        assertTrue(same(x4, 91.875, 0.000001)); 

        

    }

    

    /**

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

     */

    public void testSerialization() {



        NumberAxis a1 = new NumberAxis("Test Axis");

        NumberAxis a2 = null;



        try {

            ByteArrayOutputStream buffer = new ByteArrayOutputStream();

            ObjectOutput out = new ObjectOutputStream(buffer);

            out.writeObject(a1);

            out.close();



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

            a2 = (NumberAxis) in.readObject();

            in.close();

        }

        catch (Exception e) {

            System.out.println(e.toString());

        }

        assertEquals(a1, a2);



    }



    /**

     * A simple test for the auto-range calculation.

     */

    public void testAutoRange1() {

        DefaultCategoryDataset dataset = new DefaultCategoryDataset();

        dataset.setValue(100.0, "Row 1", "Column 1");

        dataset.setValue(200.0, "Row 1", "Column 2");

        JFreeChart chart = ChartFactory.createBarChart(

            "Test", 

            "Categories",

            "Value",

            dataset,

            PlotOrientation.VERTICAL,

            false, 

            false,

            false

        );

        NumberAxis axis = (NumberAxis) chart.getCategoryPlot().getRangeAxis();

        // range should be 0.0 - 210.0

        assertTrue(same(axis.getLowerBound(), 0.0, 0.00001));    

        assertTrue(same(axis.getUpperBound(), 210.0, 0.00001));    

    }

    

    /**

     * A simple test for the auto-range calculation.

     */

    public void testAutoRange2() {

        DefaultCategoryDataset dataset = new DefaultCategoryDataset();

        dataset.setValue(100.0, "Row 1", "Column 1");

        dataset.setValue(200.0, "Row 1", "Column 2");

        JFreeChart chart = ChartFactory.createBarChart(

            "Test", 

            "Categories",

            "Value",

            dataset,

            PlotOrientation.VERTICAL,

            false, 

            false,

            false

        );

        NumberAxis axis = (NumberAxis) chart.getCategoryPlot().getRangeAxis();

        axis.setAutoRangeIncludesZero(false);

        // range should be 100.0 - 205.0

        assertTrue(same(axis.getLowerBound(), 95.0, 0.00001));    

        assertTrue(same(axis.getUpperBound(), 205.0, 0.00001));    

    }

    

    /**

     * A simple test for the auto-range calculation.

     */

    public void testAutoRange3() {

        DefaultCategoryDataset dataset = new DefaultCategoryDataset();

        dataset.setValue(100.0, "Row 1", "Column 1");

        dataset.setValue(200.0, "Row 1", "Column 2");

        JFreeChart chart = ChartFactory.createBarChart(

            "Test", 

            "Categories",

            "Value",

            dataset,

            PlotOrientation.VERTICAL,

            false, 

            false,

            false

        );

        NumberAxis axis = (NumberAxis) chart.getCategoryPlot().getRangeAxis();

        axis.setAutoRangeIncludesZero(false);

        

        // range should be 100.0 - 205.0

        assertTrue(same(axis.getLowerBound(), 95.0, 0.00001));    

        assertTrue(same(axis.getUpperBound(), 205.0, 0.00001));    

        

        DefaultCategoryDataset dataset2 = new DefaultCategoryDataset();

        dataset2.setValue(900.0, "Row 1", "Column 1");

        dataset2.setValue(1000.0, "Row 1", "Column 2");

        chart.getCategoryPlot().setDataset(dataset2);

        assertTrue(same(axis.getLowerBound(), 895.0, 0.00001));    

        assertTrue(same(axis.getUpperBound(), 1005.0, 0.00001));    

    }

    

}

