XisSymbolic


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   * XisSymbolic.java
29   * ----------------
30   *
31   * Original Author:  Anthony Boulestreau;
32   * Contributor(s):   David Gilbert (for Object Refinery Limited);
33   *
34   * $Id: XisSymbolic.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   *
41   */
42  
43  package org.jfree.data.xy;
44  
45  /**
46   * Represent a data set where X is a symbolic values. Each symbolic value is
47   * linked with an Integer.
48   *
49   * @author Anthony Boulestreau
50   */
51  public interface XisSymbolic {
52  
53      /**
54       * Returns the list of symbolic values.
55       *
56       * @return An array of symbolic values.
57       */
58      public String  [] getXSymbolicValues();
59  
60      /**
61       * Returns the symbolic value of the data set specified by
62       * <CODE>series</CODE> and <CODE>item</CODE> parameters.
63       *
64       * @param series  value of the serie.
65       * @param item  value of the item.
66       *
67       * @return The symbolic value.
68       */
69      public String   getXSymbolicValue(int series, int item);
70  
71      /**
72       * Returns the symbolic value linked with the specified
73       * <CODE>Integer</CODE>.
74       *
75       * @param val  value of the integer linked with the symbolic value.
76       *
77       * @return The symbolic value.
78       */
79      public String   getXSymbolicValue(Integer   val);
80      
81  }
82
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags