Source for org.jfree.chart.labels.BoxAndWhiskerXYToolTipGenerator

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ------------------------------------
  28:  * BoxAndWhiskerXYToolTipGenerator.java
  29:  * ------------------------------------
  30:  * (C) Copyright 2003-2007, by David Browning and Contributors.
  31:  *
  32:  * Original Author:  David Browning;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 05-Aug-2003 : Version 1, contributed by David Browning (DG);
  38:  * 13-Aug-2003 : Implemented Cloneable (DG);
  39:  * 28-Aug-2003 : Updated for changes in dataset API (DG);
  40:  * 25-Feb-2004 : Renamed XYToolTipGenerator --> XYItemLabelGenerator (DG);
  41:  * 27-Feb-2004 : Renamed BoxAndWhiskerItemLabelGenerator --> 
  42:  *               BoxAndWhiskerXYItemLabelGenerator, and modified to use 
  43:  *               MessageFormat (DG);
  44:  * 15-Jul-2004 : Switched getX() with getXValue() and getY() with 
  45:  *               getYValue() (DG);
  46:  * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
  47:  *
  48:  */
  49: 
  50: package org.jfree.chart.labels;
  51: 
  52: import java.io.Serializable;
  53: import java.text.DateFormat;
  54: import java.text.MessageFormat;
  55: import java.text.NumberFormat;
  56: import java.util.Date;
  57: 
  58: import org.jfree.data.statistics.BoxAndWhiskerXYDataset;
  59: import org.jfree.data.xy.XYDataset;
  60: 
  61: /**
  62:  * An item label generator for plots that use data from a 
  63:  * {@link BoxAndWhiskerXYDataset}.
  64:  * <P>
  65:  * The tooltip text and item label text are composed using a 
  66:  * {@link java.text.MessageFormat} object, that can aggregate some or all of 
  67:  * the following string values into a message.
  68:  * <table>
  69:  * <tr><td>0</td><td>Series Name</td></tr>
  70:  * <tr><td>1</td><td>X (value or date)</td></tr>
  71:  * <tr><td>2</td><td>Mean</td></tr>
  72:  * <tr><td>3</td><td>Median</td></tr>
  73:  * <tr><td>4</td><td>Minimum</td></tr>
  74:  * <tr><td>5</td><td>Maximum</td></tr>
  75:  * <tr><td>6</td><td>Quartile 1</td></tr>
  76:  * <tr><td>7</td><td>Quartile 3</td></tr>
  77:  * </table>
  78:  */
  79: public class BoxAndWhiskerXYToolTipGenerator extends StandardXYToolTipGenerator
  80:                                              implements XYToolTipGenerator,
  81:                                                         Cloneable,
  82:                                                         Serializable {
  83: 
  84:     /** For serialization. */
  85:     private static final long serialVersionUID = -2648775791161459710L;
  86:     
  87:     /** The default tooltip format string. */
  88:     public static final String DEFAULT_TOOL_TIP_FORMAT 
  89:         = "X: {1} Mean: {2} Median: {3} Min: {4} Max: {5} Q1: {6} Q3: {7} ";
  90:     
  91:     /**
  92:      * Creates a default item label generator.
  93:      */
  94:     public BoxAndWhiskerXYToolTipGenerator() {
  95:         super(
  96:             DEFAULT_TOOL_TIP_FORMAT,
  97:             NumberFormat.getInstance(), NumberFormat.getInstance()
  98:         );
  99:     }
 100: 
 101:     /**
 102:      * Creates a new item label generator.  If the date formatter is not 
 103:      * <code>null</code>, the x-values will be formatted as dates.
 104:      * 
 105:      * @param toolTipFormat  the tool tip format string (<code>null</code> not 
 106:      *                       permitted).
 107:      * @param numberFormat  the number formatter (<code>null</code> not 
 108:      *                      permitted).
 109:      * @param dateFormat  the date formatter (<code>null</code> permitted).
 110:      */
 111:     public BoxAndWhiskerXYToolTipGenerator(String toolTipFormat, 
 112:                                            DateFormat dateFormat, 
 113:                                            NumberFormat numberFormat) {
 114:         
 115:         super(toolTipFormat, dateFormat, numberFormat);
 116:     
 117:     }
 118:     
 119:     /**
 120:      * Creates the array of items that can be passed to the 
 121:      * {@link MessageFormat} class for creating labels.
 122:      *
 123:      * @param dataset  the dataset (<code>null</code> not permitted).
 124:      * @param series  the series (zero-based index).
 125:      * @param item  the item (zero-based index).
 126:      *
 127:      * @return The items (never <code>null</code>).
 128:      */
 129:     protected Object[] createItemArray(XYDataset dataset, int series, 
 130:                                        int item) {
 131:         Object[] result = new Object[8];
 132:         result[0] = dataset.getSeriesKey(series).toString();
 133:         Number x = dataset.getX(series, item);
 134:         if (getXDateFormat() != null) {
 135:             result[1] = getXDateFormat().format(new Date(x.longValue()));   
 136:         }
 137:         else {
 138:             result[1] = getXFormat().format(x);
 139:         }
 140:         NumberFormat formatter = getYFormat();
 141:         
 142:         if (dataset instanceof BoxAndWhiskerXYDataset) {
 143:             BoxAndWhiskerXYDataset d = (BoxAndWhiskerXYDataset) dataset;
 144:             result[2] = formatter.format(d.getMeanValue(series, item));
 145:             result[3] = formatter.format(d.getMedianValue(series, item));
 146:             result[4] = formatter.format(d.getMinRegularValue(series, item));
 147:             result[5] = formatter.format(d.getMaxRegularValue(series, item));
 148:             result[6] = formatter.format(d.getQ1Value(series, item));
 149:             result[7] = formatter.format(d.getQ3Value(series, item));
 150:         }
 151:         return result;
 152:     }
 153: 
 154:     /**
 155:      * Tests if this object is equal to another.
 156:      *
 157:      * @param obj  the other object.
 158:      *
 159:      * @return A boolean.
 160:      */
 161:     public boolean equals(Object obj) {
 162:         if (obj == this) {
 163:             return true;
 164:         }
 165:         if (!(obj instanceof BoxAndWhiskerXYToolTipGenerator)) {
 166:             return false;
 167:         }
 168:         return super.equals(obj);
 169:     }
 170:     
 171: }