1. /* ===========================================================

  2.  * JFreeChart : a free chart library for the Java(tm) platform

  3.  * ===========================================================

  4.  *

  5.  * (C) Copyright 2000-2004, 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 under the terms

  10.  * of the GNU Lesser General Public License as published by the Free Software Foundation;

  11.  * either version 2.1 of the License, or (at your option) any later version.

  12.  *

  13.  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  14.  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  15.  * See the GNU Lesser General Public License for more details.

  16.  *

  17.  * You should have received a copy of the GNU Lesser General Public License along with this

  18.  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

  19.  * Boston, MA 02111-1307, USA.

  20.  *

  21.  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

  22.  * in the United States and other countries.]

  23.  *

  24.  * ----------------

  25.  * YisSymbolic.java

  26.  * ----------------

  27.  *

  28.  * Original Author:  Anthony Boulestreau;

  29.  * Contributor(s):   David Gilbert (for Object Refinery Limited);

  30.  *

  31.  * $Id: YisSymbolic.java,v 1.1 2004/08/31 15:36:12 mungady Exp $

  32.  *

  33.  * Changes (from 21-Aug-2001)

  34.  * --------------------------

  35.  * 29-Mar-2002 : First version (AB);

  36.  * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);

  37.  * 18-Aug-2004 : Moved from org.jfree.data --> org.jfree.data.xy (DG);

  38.  *

  39.  */

  40. 

  41. package org.jfree.data.xy;

  42. 

  43. /**

  44.  * Represent a data set where Y is a symbolic values. Each symbolic value is

  45.  * linked with an Integer.

  46.  *

  47.  * @author Anthony Boulestreau

  48.  */

  49. public interface YisSymbolic {

  50. 

  51.     /**

  52.      * Returns the list of symbolic values.

  53.      *

  54.      * @return The symbolic values.

  55.      */

  56.     public String[] getYSymbolicValues();

  57. 

  58.     /**

  59.      * Returns the symbolic value of the data set specified by

  60.      * <CODE>series</CODE> and <CODE>item</CODE> parameters.

  61.      *

  62.      * @param series  the series index (zero-based).

  63.      * @param item  the item index (zero-based).

  64.      *

  65.      * @return The symbolic value.

  66.      */

  67.     public String getYSymbolicValue(int series, int item);

  68. 

  69.     /**

  70.      * Returns the symbolic value linked with the specified

  71.      * <CODE>Integer</CODE>.

  72.      *

  73.      * @param val  value of the integer linked with the symbolic value.

  74.      *

  75.      * @return The symbolic value.

  76.      */

  77.     public String getYSymbolicValue(Integer val);

  78.     

  79. }