Source for org.jfree.chart.labels.StandardCategoryItemLabelGenerator

   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:  * StandardCategoryItemLabelGenerator.java
  29:  * ---------------------------------------
  30:  * (C) Copyright 2004-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 11-May-2004 : Version 1 (DG);
  38:  * 20-Apr-2005 : Renamed StandardCategoryLabelGenerator 
  39:  *               --> StandardCategoryItemLabelGenerator (DG);
  40:  * ------------- JFREECHART 1.0.0 ---------------------------------------------
  41:  * 03-May-2005 : Added equals() implementation, to fix bug 1481087 (DG);
  42:  */
  43: 
  44: package org.jfree.chart.labels;
  45: 
  46: import java.io.Serializable;
  47: import java.text.DateFormat;
  48: import java.text.NumberFormat;
  49: 
  50: import org.jfree.data.category.CategoryDataset;
  51: import org.jfree.util.PublicCloneable;
  52: 
  53: /**
  54:  * A standard label generator that can be used with a 
  55:  * {@link org.jfree.chart.renderer.category.CategoryItemRenderer}.
  56:  */
  57: public class StandardCategoryItemLabelGenerator 
  58:     extends AbstractCategoryItemLabelGenerator 
  59:     implements CategoryItemLabelGenerator, Cloneable, PublicCloneable,
  60:                Serializable {
  61: 
  62:     /** For serialization. */
  63:     private static final long serialVersionUID = 3499701401211412882L;
  64:     
  65:     /** The default format string. */
  66:     public static final String DEFAULT_LABEL_FORMAT_STRING = "{2}";
  67:     
  68:     /**
  69:      * Creates a new generator with a default number formatter.
  70:      */
  71:     public StandardCategoryItemLabelGenerator() {
  72:         super(DEFAULT_LABEL_FORMAT_STRING, NumberFormat.getInstance());
  73:     }
  74: 
  75:     /**
  76:      * Creates a new generator with the specified number formatter.
  77:      *
  78:      * @param labelFormat  the label format string (<code>null</code> not 
  79:      *                     permitted).
  80:      * @param formatter  the number formatter (<code>null</code> not permitted).
  81:      */
  82:     public StandardCategoryItemLabelGenerator(String labelFormat, 
  83:                                               NumberFormat formatter) {
  84:         super(labelFormat, formatter);
  85:     }
  86:     
  87:     /**
  88:      * Creates a new generator with the specified number formatter.
  89:      *
  90:      * @param labelFormat  the label format string (<code>null</code> not 
  91:      *                     permitted).
  92:      * @param formatter  the number formatter (<code>null</code> not permitted).
  93:      * @param percentFormatter  the percent formatter (<code>null</code> not
  94:      *     permitted).
  95:      * 
  96:      * @since 1.0.2
  97:      */
  98:     public StandardCategoryItemLabelGenerator(String labelFormat, 
  99:             NumberFormat formatter, NumberFormat percentFormatter) {
 100:         super(labelFormat, formatter, percentFormatter);
 101:     }
 102:     
 103:     /**
 104:      * Creates a new generator with the specified date formatter.
 105:      *
 106:      * @param labelFormat  the label format string (<code>null</code> not 
 107:      *                     permitted).
 108:      * @param formatter  the date formatter (<code>null</code> not permitted).
 109:      */
 110:     public StandardCategoryItemLabelGenerator(String labelFormat, 
 111:                                               DateFormat formatter) {
 112:         super(labelFormat, formatter);
 113:     }
 114:     
 115:     /**
 116:      * Generates the label for an item in a dataset.  Note: in the current 
 117:      * dataset implementation, each row is a series, and each column contains 
 118:      * values for a particular category.
 119:      *
 120:      * @param dataset  the dataset (<code>null</code> not permitted).
 121:      * @param row  the row index (zero-based).
 122:      * @param column  the column index (zero-based).
 123:      *
 124:      * @return The label (possibly <code>null</code>).
 125:      */
 126:     public String generateLabel(CategoryDataset dataset, int row, int column) {
 127:         return generateLabelString(dataset, row, column);
 128:     }
 129:     
 130:     /**
 131:      * Tests this generator for equality with an arbitrary object.
 132:      * 
 133:      * @param obj  the object (<code>null</code> permitted).
 134:      * 
 135:      * @return <code>true</code> if this generator is equal to 
 136:      *     <code>obj</code>, and <code>false</code> otherwise.
 137:      */
 138:     public boolean equals(Object obj) {
 139:         if (obj == this) {
 140:             return true;
 141:         }
 142:         if (!(obj instanceof StandardCategoryItemLabelGenerator)) {
 143:             return false;
 144:         }
 145:         return super.equals(obj);
 146:     }
 147: }