001 /* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 025 * in the United States and other countries.] 026 * 027 * --------------------------------- 028 * CategorySeriesLabelGenerator.java 029 * --------------------------------- 030 * (C) Copyright 2005, 2006, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * $Id: CategorySeriesLabelGenerator.java,v 1.1.2.2 2006/11/24 15:25:04 mungady Exp $ 036 * 037 * Changes 038 * ------- 039 * 20-Apr-2005 : Version 1 (DG); 040 * ------------- JFREECHART 1.0.x --------------------------------------------- 041 * 24-Nov-2006 : Updated API docs (DG); 042 * 043 */ 044 045 package org.jfree.chart.labels; 046 047 import org.jfree.data.category.CategoryDataset; 048 049 /** 050 * A generator that creates labels for the series in a {@link CategoryDataset}. 051 * <P> 052 * Classes that implement this interface should be either (a) immutable, or 053 * (b) cloneable via the <code>PublicCloneable</code> interface (defined in 054 * the JCommon class library). This provides a mechanism for the referring 055 * renderer to clone the generator if necessary. 056 */ 057 public interface CategorySeriesLabelGenerator { 058 059 /** 060 * Generates a label for the specified series. 061 * 062 * @param dataset the dataset (<code>null</code> not permitted). 063 * @param series the series index. 064 * 065 * @return A series label. 066 */ 067 public String generateLabel(CategoryDataset dataset, int series); 068 069 }