XisSymbolic


1   /* ======================================
2    * JFreeChart : a free Java chart library
3    * ======================================
4    *
5    * Project Info:  http://www.jfree.org/jfreechart/index.html
6    * Project Lead:  David Gilbert (david.gilbert@object-refinery.com);
7    *
8    * (C) Copyright 2000-2003, by Object Refinery Limited and Contributors.
9    *
10   * This library is free software; you can redistribute it and/or modify it under the terms
11   * of the GNU Lesser General Public License as published by the Free Software Foundation;
12   * either version 2.1 of the License, or (at your option) any later version.
13   *
14   * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15   * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16   * See the GNU Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public License along with this
19   * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20   * Boston, MA 02111-1307, USA.
21   *
22   * ----------------
23   * XisSymbolic.java
24   * ----------------
25   *
26   * Original Author:  Anthony Boulestreau;
27   * Contributor(s):   David Gilbert (for Object Refinery Limited);
28   *
29   * $Id: XisSymbolic.java,v 1.2 2003/06/04 22:58:28 mungady Exp $
30   *
31   * Changes (from 21-Aug-2001)
32   * --------------------------
33   * 29-Mar-2002 : First version (AB);
34   * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);
35   *
36   */
37  
38  package org.jfree.data;
39  
40  /**
41   * Represent a data set where X is a symbolic values. Each symbolic value is
42   * linked with an Integer.
43   *
44   * @author Anthony Boulestreau
45   */
46  public interface XisSymbolic {
47  
48      /**
49       * Returns the list of symbolic values.
50       *
51       * @return array of symbolic value.
52       */
53      public String  [] getXSymbolicValues();
54  
55      /**
56       * Returns the symbolic value of the data set specified by
57       * <CODE>series</CODE> and <CODE>item</CODE> parameters.
58       *
59       * @param series  value of the serie.
60       * @param item  value of the item.
61       *
62       * @return the symbolic value.
63       */
64      public String   getXSymbolicValue(int series, int item);
65  
66      /**
67       * Returns the symbolic value linked with the specified
68       * <CODE>Integer</CODE>.
69       *
70       * @param val  value of the integer linked with the symbolic value.
71       *
72       * @return the symbolic value.
73       */
74      public String   getXSymbolicValue(Integer   val);
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags