01: /* ===========================================================
02: * JFreeChart : a free chart library for the Java(tm) platform
03: * ===========================================================
04: *
05: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
06: *
07: * Project Info: http://www.jfree.org/jfreechart/index.html
08: *
09: * 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.2 2007/02/02 15:14:53 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: * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
41: *
42: */
43:
44: package org.jfree.data.xy;
45:
46: /**
47: * Represent a data set where X is a symbolic values. Each symbolic value is
48: * linked with an Integer.
49: */
50: public interface XisSymbolic {
51:
52: /**
53: * Returns the list of symbolic values.
54: *
55: * @return An array of symbolic values.
56: */
57: public String[] getXSymbolicValues();
58:
59: /**
60: * Returns the symbolic value of the data set specified by
61: * <CODE>series</CODE> and <CODE>item</CODE> parameters.
62: *
63: * @param series value of the serie.
64: * @param item value of the item.
65: *
66: * @return The symbolic value.
67: */
68: public String getXSymbolicValue(int series, int item);
69:
70: /**
71: * Returns the symbolic value linked with the specified
72: * <CODE>Integer</CODE>.
73: *
74: * @param val value of the integer linked with the symbolic value.
75: *
76: * @return The symbolic value.
77: */
78: public String getXSymbolicValue(Integer val);
79:
80: }
|