Source for org.jfree.chart.labels.XYItemLabelGenerator

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, 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:  * XYItemLabelGenerator.java
  29:  * -------------------------
  30:  * (C) Copyright 2001-2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: XYItemLabelGenerator.java,v 1.1.2.1 2005/10/25 20:49:02 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 13-Dec-2001 : Version 1 (DG);
  40:  * 16-Jan-2002 : Completed Javadocs (DG);
  41:  * 13-Jun-2002 : Correction to Javadoc comments (DG);
  42:  * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
  43:  * 25-Feb-2004 : Renamed XYToolTipGenerator --> XYItemLabelGenerator (DG);
  44:  * 15-Apr-2004 : Moved the generateToolTip() method to a separate 
  45:  *               interface (DG);
  46:  * 11-May-2004 : Renamed XYItemLabelGenerator --> XYLabelGenerator (DG);
  47:  * 20-Apr-2005 : Reverted name change of 11-May-2004 (DG);
  48:  *
  49:  */
  50: 
  51: package org.jfree.chart.labels;
  52: 
  53: import org.jfree.data.xy.XYDataset;
  54: 
  55: /**
  56:  * Interface for a label generator for plots that use data from an 
  57:  * {@link XYDataset}.
  58:  */
  59: public interface XYItemLabelGenerator {
  60: 
  61:     /**
  62:      * Generates a label for the specified item. The label is typically a 
  63:      * formatted version of the data value, but any text can be used.
  64:      *
  65:      * @param dataset  the dataset (<code>null</code> not permitted).
  66:      * @param series  the series index (zero-based).
  67:      * @param item  the item index (zero-based).
  68:      *
  69:      * @return The label (possibly <code>null</code>).
  70:      */
  71:     public String generateLabel(XYDataset dataset, int series, int item);
  72: 
  73: }