/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2011, 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.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* ------------------------------------
* BoxAndWhiskerToolTipGenerator.java
* ------------------------------------
* (C) Copyright 2004-2008, by David Browning and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 02-Jun-2004 : Version 1 (DG);
* 23-Mar-2005 : Implemented PublicCloneable (DG);
*
*/
package org.jfree.chart.labels;
import java.io.Serializable;
import java.text.MessageFormat;
import java.text.NumberFormat;
import org.jfree.data.category.CategoryDataset;
import org.jfree.data.statistics.BoxAndWhiskerCategoryDataset;
import org.jfree.util.PublicCloneable;
/**
* An item label generator for plots that use data from a
* {@link BoxAndWhiskerCategoryDataset}.
* <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>
*/
public class BoxAndWhiskerToolTipGenerator
extends StandardCategoryToolTipGenerator
implements CategoryToolTipGenerator, Cloneable, PublicCloneable,
Serializable {
/** For serialization. */
private static final long serialVersionUID = -6076837753823076334L;
/** 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 tool tip generator.
*/
public BoxAndWhiskerToolTipGenerator() {
super(DEFAULT_TOOL_TIP_FORMAT, NumberFormat.getInstance());
}
/**
* Creates a tool tip formatter.
*
* @param format the tool tip format string.
* @param formatter the formatter.
*/
public BoxAndWhiskerToolTipGenerator(String format,
NumberFormat formatter) {
super(format, formatter);
}
/**
* 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(CategoryDataset dataset, int series,
int item) {
Object[] result = new Object[8];
result[0] = dataset.getRowKey(series);
Number y = dataset.getValue(series, item);
NumberFormat formatter = getNumberFormat();
result[1] = formatter.format(y);
if (dataset instanceof BoxAndWhiskerCategoryDataset) {
BoxAndWhiskerCategoryDataset d
= (BoxAndWhiskerCategoryDataset) 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 obj the other object.
*
* @return A boolean.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof BoxAndWhiskerToolTipGenerator) {
return super.equals(obj);
}
return false;
}
}