Source for org.jfree.chart.labels.StandardCategorySeriesLabelGenerator

   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:  * StandardCategorySeriesLabelGenerator.java
  29:  * -----------------------------------------
  30:  * (C) Copyright 2005-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 20-Apr-2005 : Version 1 (DG);
  38:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  39:  * 03-May-2006 : Fixed equals() method (bug 1481102) (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.labels;
  44: 
  45: import java.io.Serializable;
  46: import java.text.MessageFormat;
  47: 
  48: import org.jfree.data.category.CategoryDataset;
  49: import org.jfree.util.PublicCloneable;
  50: 
  51: /**
  52:  * A standard series label generator for plots that use data from 
  53:  * a {@link org.jfree.data.category.CategoryDataset}.
  54:  */
  55: public class StandardCategorySeriesLabelGenerator implements 
  56:     CategorySeriesLabelGenerator, Cloneable, PublicCloneable, Serializable {
  57: 
  58:     /** For serialization. */
  59:     private static final long serialVersionUID = 4630760091523940820L;
  60:     
  61:     /** The default item label format. */
  62:     public static final String DEFAULT_LABEL_FORMAT = "{0}";
  63:     
  64:     /** The format pattern. */
  65:     private String formatPattern;
  66: 
  67:     /**
  68:      * Creates a default series label generator (uses 
  69:      * {@link #DEFAULT_LABEL_FORMAT}).
  70:      */
  71:     public StandardCategorySeriesLabelGenerator() {
  72:         this(DEFAULT_LABEL_FORMAT);
  73:     }
  74:     
  75:     /**
  76:      * Creates a new series label generator.
  77:      * 
  78:      * @param format  the format pattern (<code>null</code> not permitted).
  79:      */
  80:     public StandardCategorySeriesLabelGenerator(String format) {
  81:         if (format == null) {
  82:             throw new IllegalArgumentException("Null 'format' argument.");
  83:         }
  84:         this.formatPattern = format;
  85:     }
  86: 
  87:     /**
  88:      * Generates a label for the specified series.
  89:      * 
  90:      * @param dataset  the dataset (<code>null</code> not permitted).
  91:      * @param series  the series.
  92:      * 
  93:      * @return A series label.
  94:      */
  95:     public String generateLabel(CategoryDataset dataset, int series) {
  96:         if (dataset == null) {
  97:             throw new IllegalArgumentException("Null 'dataset' argument.");
  98:         }
  99:         String label = MessageFormat.format(this.formatPattern, 
 100:                 createItemArray(dataset, series));
 101:         return label;
 102:     }
 103: 
 104:     /**
 105:      * Creates the array of items that can be passed to the 
 106:      * {@link MessageFormat} class for creating labels.
 107:      *
 108:      * @param dataset  the dataset (<code>null</code> not permitted).
 109:      * @param series  the series (zero-based index).
 110:      *
 111:      * @return The items (never <code>null</code>).
 112:      */
 113:     protected Object[] createItemArray(CategoryDataset dataset, int series) {
 114:         Object[] result = new Object[1];
 115:         result[0] = dataset.getRowKey(series).toString();
 116:         return result;
 117:     }
 118: 
 119:     /**
 120:      * Returns an independent copy of the generator.
 121:      * 
 122:      * @return A clone.
 123:      * 
 124:      * @throws CloneNotSupportedException if cloning is not supported.
 125:      */
 126:     public Object clone() throws CloneNotSupportedException { 
 127:         return super.clone();
 128:     }
 129:     
 130:     /**
 131:      * Tests this object for equality with an arbitrary object.
 132:      *
 133:      * @param obj  the other object (<code>null</code> permitted).
 134:      *
 135:      * @return A boolean.
 136:      */
 137:     public boolean equals(Object obj) {
 138:         if (obj == this) {
 139:             return true;
 140:         }
 141:         if (!(obj instanceof StandardCategorySeriesLabelGenerator)) {
 142:             return false;
 143:         }
 144:         StandardCategorySeriesLabelGenerator that 
 145:                 = (StandardCategorySeriesLabelGenerator) obj;
 146:         if (!this.formatPattern.equals(that.formatPattern)) {
 147:             return false;
 148:         }
 149:         return true;
 150:     }
 151: 
 152: }