KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > xy > IntervalXYZDataset


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  * IntervalXYZDataset.java
29  * -----------------------
30  * (C) Copyright 2001-2004, by Object Refinery Limited.
31  *
32  * Original Author: David Gilbert (for Object Refinery Limited);
33  * Contributor(s): -;
34  *
35  * $Id: IntervalXYZDataset.java,v 1.2.2.1 2005/10/25 21:36:51 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 31-Oct-2001 : Version 1 (DG);
40  *
41  */

42
43 package org.jfree.data.xy;
44
45
46 /**
47  * An extension of the {@link XYZDataset} interface that allows a range of data
48  * to be defined for any of the X values, the Y values, and the Z values.
49  */

50 public interface IntervalXYZDataset extends XYZDataset {
51
52     /**
53      * Returns the starting X value for the specified series and item.
54      *
55      * @param series the series (zero-based index).
56      * @param item the item within a series (zero-based index).
57      *
58      * @return The starting X value for the specified series and item.
59      */

60     public Number JavaDoc getStartXValue(int series, int item);
61
62     /**
63      * Returns the ending X value for the specified series and item.
64      *
65      * @param series the series (zero-based index).
66      * @param item the item within a series (zero-based index).
67      *
68      * @return The ending X value for the specified series and item.
69      */

70     public Number JavaDoc getEndXValue(int series, int item);
71
72     /**
73      * Returns the starting Y value for the specified series and item.
74      *
75      * @param series the series (zero-based index).
76      * @param item the item within a series (zero-based index).
77      *
78      * @return The starting Y value for the specified series and item.
79      */

80     public Number JavaDoc getStartYValue(int series, int item);
81
82     /**
83      * Returns the ending Y value for the specified series and item.
84      *
85      * @param series the series (zero-based index).
86      * @param item the item within a series (zero-based index).
87      *
88      * @return The ending Y value for the specified series and item.
89      */

90     public Number JavaDoc getEndYValue(int series, int item);
91
92     /**
93      * Returns the starting Z value for the specified series and item.
94      *
95      * @param series the series (zero-based index).
96      * @param item the item within a series (zero-based index).
97      *
98      * @return The starting Z value for the specified series and item.
99      */

100     public Number JavaDoc getStartZValue(int series, int item);
101
102     /**
103      * Returns the ending Z value for the specified series and item.
104      *
105      * @param series the series (zero-based index).
106      * @param item the item within a series (zero-based index).
107      *
108      * @return The ending Z value for the specified series and item.
109      */

110     public Number JavaDoc getEndZValue(int series, int item);
111
112 }
113
Popular Tags