Frames | No Frames |
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: * CategorySeriesLabelGenerator.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: * 24-Nov-2006 : Updated API docs (DG); 40: * 41: */ 42: 43: package org.jfree.chart.labels; 44: 45: import org.jfree.data.category.CategoryDataset; 46: 47: /** 48: * A generator that creates labels for the series in a {@link CategoryDataset}. 49: * <P> 50: * Classes that implement this interface should be either (a) immutable, or 51: * (b) cloneable via the <code>PublicCloneable</code> interface (defined in 52: * the JCommon class library). This provides a mechanism for the referring 53: * renderer to clone the generator if necessary. 54: */ 55: public interface CategorySeriesLabelGenerator { 56: 57: /** 58: * Generates a label for the specified series. 59: * 60: * @param dataset the dataset (<code>null</code> not permitted). 61: * @param series the series index. 62: * 63: * @return A series label. 64: */ 65: public String generateLabel(CategoryDataset dataset, int series); 66: 67: }