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

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

 *

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

 * BoxAndWhiskerXYToolTipGenerator.java

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

 * (C) Copyright 2003, 2004, by David Browning and Contributors.

 *

 * Original Author:  David Browning;

 * Contributor(s):   David Gilbert (for Object Refinery Limited);

 *

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

 *

 * Changes

 * -------

 * 05-Aug-2003 : Version 1, contributed by David Browning (DG);

 * 13-Aug-2003 : Implemented Cloneable (DG);

 * 28-Aug-2003 : Updated for changes in dataset API (DG);

 * 25-Feb-2004 : Renamed XYToolTipGenerator --> XYItemLabelGenerator (DG);

 * 27-Feb-2004 : Renamed BoxAndWhiskerItemLabelGenerator --> BoxAndWhiskerXYItemLabelGenerator,

 *               and modified to use MessageFormat (DG);

 * 15-Jul-2004 : Switched getX() with getXValue() and getY() with getYValue() (DG);

 *

 */



package org.jfree.chart.labels;



import java.io.Serializable;

import java.text.DateFormat;

import java.text.MessageFormat;

import java.text.NumberFormat;

import java.util.Date;



import org.jfree.data.statistics.BoxAndWhiskerXYDataset;

import org.jfree.data.xy.XYDataset;



/**

 * An item label generator for plots that use data from a 

 * {@link BoxAndWhiskerXYDataset}.

 * <P>

 * The tooltip text and item label text are composed using a {@link java.text.MessageFormat} 

 * object, that can aggregate some or all of the following string values into a message.

 * <table>

 * <tr><td>0</td><td>Series Name</td></tr>

 * <tr><td>1</td><td>X (value or date)</td></tr>

 * <tr><td>2</td><td>Mean</td></tr>

 * <tr><td>3</td><td>Median</td></tr>

 * <tr><td>4</td><td>Minimum</td></tr>

 * <tr><td>5</td><td>Maximum</td></tr>

 * <tr><td>6</td><td>Quartile 1</td></tr>

 * <tr><td>7</td><td>Quartile 3</td></tr>

 * </table>

 * 

 * @author David Browning

 */

public class BoxAndWhiskerXYToolTipGenerator extends StandardXYToolTipGenerator

                                             implements XYToolTipGenerator,

                                                        Cloneable,

                                                        Serializable {



    /** The default tooltip format string. */

    public static final String DEFAULT_TOOL_TIP_FORMAT 

        = "X: {1} Mean: {2} Median: {3} Min: {4} Max: {5} Q1: {6} Q3: {7} ";

    

    /**

     * Creates a default item label generator.

     */

    public BoxAndWhiskerXYToolTipGenerator() {

        super(

            DEFAULT_TOOL_TIP_FORMAT,

            NumberFormat.getInstance(), NumberFormat.getInstance()

        );

    }



    /**

     * Creates a new item label generator.  If the date formatter is not <code>null</code>,

     * the x-values will be formatted as dates.

     * 

     * @param toolTipFormat  the tool tip format string (<code>null</code> not permitted).

     * @param numberFormat  the number formatter (<code>null</code> not permitted).

     * @param dateFormat  the date formatter (<code>null</code> permitted).

     */

    public BoxAndWhiskerXYToolTipGenerator(String toolTipFormat, 

                                           DateFormat dateFormat, 

                                           NumberFormat numberFormat) {

        

        super(toolTipFormat, dateFormat, numberFormat);

    

    }

    

    /**

     * Creates the array of items that can be passed to the {@link MessageFormat} class

     * for creating labels.

     *

     * @param dataset  the dataset (<code>null</code> not permitted).

     * @param series  the series (zero-based index).

     * @param item  the item (zero-based index).

     *

     * @return the items (never <code>null</code>).

     */

    protected Object[] createItemArray(XYDataset dataset, int series, int item) {

        Object[] result = new Object[8];

        result[0] = dataset.getSeriesName(series);

        Number x = dataset.getX(series, item);

        if (getXDateFormat() != null) {

            result[1] = getXDateFormat().format(new Date(x.longValue()));   

        }

        else {

            result[1] = getXFormat().format(x);

        }

        NumberFormat formatter = getYFormat();

        

        if (dataset instanceof BoxAndWhiskerXYDataset) {

            BoxAndWhiskerXYDataset d = (BoxAndWhiskerXYDataset) dataset;

            result[2] = formatter.format(d.getMeanValue(series, item));

            result[3] = formatter.format(d.getMedianValue(series, item));

            result[4] = formatter.format(d.getMinRegularValue(series, item));

            result[5] = formatter.format(d.getMaxRegularValue(series, item));

            result[6] = formatter.format(d.getQ1Value(series, item));

            result[7] = formatter.format(d.getQ3Value(series, item));

        }

        return result;

    }



    /**

     * Tests if this object is equal to another.

     *

     * @param o  the other object.

     *

     * @return A boolean.

     */

    public boolean equals(Object o) {



        if (o == null) {

            return false;

        }

        if (o == this) {

            return true;

        }



        if (o instanceof BoxAndWhiskerXYToolTipGenerator) {

            return super.equals(o);

        }



        return false;



    }

    

}

