Source for org.jfree.chart.labels.BoxAndWhiskerToolTipGenerator

   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:  * BoxAndWhiskerToolTipGenerator.java
  29:  * ------------------------------------
  30:  * (C) Copyright 2004-2007, by David Browning and Contributors.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 02-Jun-2004 : Version 1 (DG);
  38:  * 23-Mar-2005 : Implemented PublicCloneable (DG);
  39:  *
  40:  */
  41: 
  42: package org.jfree.chart.labels;
  43: 
  44: import java.io.Serializable;
  45: import java.text.MessageFormat;
  46: import java.text.NumberFormat;
  47: 
  48: import org.jfree.data.category.CategoryDataset;
  49: import org.jfree.data.statistics.BoxAndWhiskerCategoryDataset;
  50: import org.jfree.util.PublicCloneable;
  51: 
  52: /**
  53:  * An item label generator for plots that use data from a 
  54:  * {@link BoxAndWhiskerCategoryDataset}.
  55:  * <P>
  56:  * The tooltip text and item label text are composed using a 
  57:  * {@link java.text.MessageFormat} object, that can aggregate some or all of 
  58:  * the following string values into a message.
  59:  * <table>
  60:  * <tr><td>0</td><td>Series Name</td></tr>
  61:  * <tr><td>1</td><td>X (value or date)</td></tr>
  62:  * <tr><td>2</td><td>Mean</td></tr>
  63:  * <tr><td>3</td><td>Median</td></tr>
  64:  * <tr><td>4</td><td>Minimum</td></tr>
  65:  * <tr><td>5</td><td>Maximum</td></tr>
  66:  * <tr><td>6</td><td>Quartile 1</td></tr>
  67:  * <tr><td>7</td><td>Quartile 3</td></tr>
  68:  * </table>
  69:  */
  70: public class BoxAndWhiskerToolTipGenerator 
  71:         extends StandardCategoryToolTipGenerator
  72:         implements CategoryToolTipGenerator, Cloneable, PublicCloneable,
  73:                    Serializable {
  74: 
  75:     /** For serialization. */
  76:     private static final long serialVersionUID = -6076837753823076334L;
  77:     
  78:     /** The default tooltip format string. */
  79:     public static final String DEFAULT_TOOL_TIP_FORMAT 
  80:             = "X: {1} Mean: {2} Median: {3} Min: {4} Max: {5} Q1: {6} Q3: {7} ";
  81:     
  82:     /**
  83:      * Creates a default tool tip generator.
  84:      */
  85:     public BoxAndWhiskerToolTipGenerator() {
  86:         super(DEFAULT_TOOL_TIP_FORMAT, NumberFormat.getInstance());
  87:     }
  88:     
  89:     /**
  90:      * Creates a tool tip formatter.
  91:      * 
  92:      * @param format  the tool tip format string.
  93:      * @param formatter  the formatter.
  94:      */
  95:     public BoxAndWhiskerToolTipGenerator(String format, 
  96:                                          NumberFormat formatter) {
  97:         super(format, formatter);   
  98:     }
  99:     
 100:     /**
 101:      * Creates the array of items that can be passed to the 
 102:      * {@link MessageFormat} class for creating labels.
 103:      *
 104:      * @param dataset  the dataset (<code>null</code> not permitted).
 105:      * @param series  the series (zero-based index).
 106:      * @param item  the item (zero-based index).
 107:      *
 108:      * @return The items (never <code>null</code>).
 109:      */
 110:     protected Object[] createItemArray(CategoryDataset dataset, int series, 
 111:                                        int item) {
 112:         Object[] result = new Object[8];
 113:         result[0] = dataset.getRowKey(series);
 114:         Number y = dataset.getValue(series, item);
 115:         NumberFormat formatter = getNumberFormat();
 116:         result[1] = formatter.format(y);
 117:         if (dataset instanceof BoxAndWhiskerCategoryDataset) {
 118:             BoxAndWhiskerCategoryDataset d 
 119:                 = (BoxAndWhiskerCategoryDataset) dataset;
 120:             result[2] = formatter.format(d.getMeanValue(series, item));
 121:             result[3] = formatter.format(d.getMedianValue(series, item));
 122:             result[4] = formatter.format(d.getMinRegularValue(series, item));
 123:             result[5] = formatter.format(d.getMaxRegularValue(series, item));
 124:             result[6] = formatter.format(d.getQ1Value(series, item));
 125:             result[7] = formatter.format(d.getQ3Value(series, item));
 126:         }
 127:         return result;
 128:     }
 129: 
 130:     /**
 131:      * Tests if this object is equal to another.
 132:      *
 133:      * @param obj  the other object.
 134:      *
 135:      * @return A boolean.
 136:      */
 137:     public boolean equals(Object obj) {
 138:         if (obj == this) {
 139:             return true;
 140:         }
 141:         if (obj instanceof BoxAndWhiskerToolTipGenerator) {
 142:             return super.equals(obj);
 143:         }
 144:         return false;
 145:     }
 146:     
 147: }