YisSymbolic


1   /* ===========================================================
2    * JFreeChart : a free chart library for the Java(tm) platform
3    * ===========================================================
4    *
5    * (C) Copyright 2000-2005, 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   * YisSymbolic.java
29   * ----------------
30   *
31   * Original Author:  Anthony Boulestreau;
32   * Contributor(s):   David Gilbert (for Object Refinery Limited);
33   *
34   * $Id: YisSymbolic.java,v 1.2.2.1 2005/10/25 21:36:51 mungady Exp $
35   *
36   * Changes (from 21-Aug-2001)
37   * --------------------------
38   * 29-Mar-2002 : First version (AB);
39   * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);
40   * 18-Aug-2004 : Moved from org.jfree.data --> org.jfree.data.xy (DG);
41   *
42   */
43  
44  package org.jfree.data.xy;
45  
46  /**
47   * Represent a data set where Y is a symbolic values. Each symbolic value is
48   * linked with an Integer.
49   *
50   * @author Anthony Boulestreau
51   */
52  public interface YisSymbolic {
53  
54      /**
55       * Returns the list of symbolic values.
56       *
57       * @return The symbolic values.
58       */
59      public String  [] getYSymbolicValues();
60  
61      /**
62       * Returns the symbolic value of the data set specified by
63       * <CODE>series</CODE> and <CODE>item</CODE> parameters.
64       *
65       * @param series  the series index (zero-based).
66       * @param item  the item index (zero-based).
67       *
68       * @return The symbolic value.
69       */
70      public String   getYSymbolicValue(int series, int item);
71  
72      /**
73       * Returns the symbolic value linked with the specified
74       * <CODE>Integer</CODE>.
75       *
76       * @param val  value of the integer linked with the symbolic value.
77       *
78       * @return The symbolic value.
79       */
80      public String   getYSymbolicValue(Integer   val);
81      
82  }
83
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags