/* =========================================================== * JFreeChart : a free chart library for the Java(tm) platform * =========================================================== * * (C) Copyright 2000-2005, 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.] * * ------------------------------------ * BoxAndWhiskerXYToolTipGenerator.java * ------------------------------------ * (C) Copyright 2003-2005, by David Browning and Contributors. * * Original Author: David Browning; * Contributor(s): David Gilbert (for Object Refinery Limited); * * $Id: BoxAndWhiskerXYToolTipGenerator.java,v 1.4.2.1 2005/10/25 20:49:02 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}. *
* 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. *
0 | Series Name |
1 | X (value or date) |
2 | Mean |
3 | Median |
4 | Minimum |
5 | Maximum |
6 | Quartile 1 |
7 | Quartile 3 |
null
, the x-values will be formatted as dates.
*
* @param toolTipFormat the tool tip format string (null
not
* permitted).
* @param numberFormat the number formatter (null
not
* permitted).
* @param dateFormat the date formatter (null
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 (null
not permitted).
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The items (never null
).
*/
protected Object[] createItemArray(XYDataset dataset, int series,
int item) {
Object[] result = new Object[8];
result[0] = dataset.getSeriesKey(series).toString();
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 obj the other object.
*
* @return A boolean.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof BoxAndWhiskerXYToolTipGenerator)) {
return false;
}
return super.equals(obj);
}
}