/* ===========================================================
 
* JFreeChart : a free chart library for the Java(tm) platform
 
* ===========================================================
 
*
 
* (C) Copyright 2000-2016, 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.
 
*
 
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 
* Other names may be trademarks of their respective owners.]
 
*
 
* ---------------------------
 
* XYSeriesLabelGenerator.java
 
* ---------------------------
 
* (C) Copyright 2004-2008, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
-;
 
*
 
* Changes
 
* -------
 
* 16-Nov-2004 : Version 1 (DG);
 
* ------------- JFREECHART 1.0.x ---------------------------------------------
 
* 24-Nov-2006 : Updated API docs (DG);
 
*
 
*/

package org.jfree.chart.labels;

import org.jfree.data.xy.XYDataset;

/**
 
* A generator that creates labels for the series in an {@link XYDataset}.
 
* <P>
 
* Classes that implement this interface should be either (a) immutable, or
 
* (b) cloneable via the {@code PublicCloneable} interface (defined in
 
* the JCommon class library).
  
This provides a mechanism for the referring
 
* renderer to clone the generator if necessary.
 
*/

public interface XYSeriesLabelGenerator {

    
/**
     
* Generates a label for the specified series.
  
This label will be
     
* used for the chart legend.
     
*
     
* @param dataset
  
the dataset ({@code null} not permitted).
     
* @param series
  
the series.
     
*
     
* @return A series label.
     
*/

    
public String generateLabel(XYDataset dataset, int series);

}