/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* ---------------------------------
* CategorySeriesLabelGenerator.java
* ---------------------------------
* (C) Copyright 2005-2007, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 20-Apr-2005 : Version 1 (DG);
* ------------- JFREECHART 1.0.x ---------------------------------------------
* 24-Nov-2006 : Updated API docs (DG);
*
*/
package org.jfree.chart.labels;
import org.jfree.data.category.CategoryDataset;
/**
* A generator that creates labels for the series in a {@link CategoryDataset}.
* <P>
* Classes that implement this interface should be either (a) immutable, or
* (b) cloneable via the <code>PublicCloneable</code> interface (defined in
* the JCommon class library). This provides a mechanism for the referring
* renderer to clone the generator if necessary.
*/
public interface CategorySeriesLabelGenerator {
/**
* Generates a label for the specified series.
*
* @param dataset the dataset (<code>null</code> not permitted).
* @param series the series index.
*
* @return A series label.
*/
public String generateLabel(CategoryDataset dataset, int series);
}
|