KickJava   Java API By Example, From Geeks To Geeks.

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


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  * IntervalXYDataset.java
29  * ----------------------
30  * (C) Copyright 2001-2004, by Object Refinery Limited and Contributors.
31  *
32  * Original Author: Mark Watson (www.markwatson.com);
33  * Contributor(s): David Gilbert (for Object Refinery Limited);
34  *
35  * $Id: IntervalXYDataset.java,v 1.2.2.1 2005/10/25 21:36:51 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 18-Oct-2001 : Version 1, thanks to Mark Watson (DG);
40  * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc (DG);
41  * 06-May-2004 : Added methods that return double primitives (DG);
42  *
43  */
44
45 package org.jfree.data.xy;
46
47
48 /**
49  * An extension of the {@link XYDataset} interface that allows a range of data
50  * to be defined for the X values, the Y values, or both the X and Y values.
51  * This interface is used to support (among other things) bar plots against
52  * numerical axes.
53  */
54 public interface IntervalXYDataset extends XYDataset {
55
56     /**
57      * Returns the starting X value for the specified series and item.
58      *
59      * @param series the series index (zero-based).
60      * @param item the item index (zero-based).
61      *
62      * @return The value.
63      */
64     public Number JavaDoc getStartX(int series, int item);
65
66     /**
67      * Returns the start x-value (as a double primitive) for an item within a
68      * series.
69      *
70      * @param series the series (zero-based index).
71      * @param item the item (zero-based index).
72      *
73      * @return The start x-value.
74      */
75     public double getStartXValue(int series, int item);
76
77     /**
78      * Returns the ending X value for the specified series and item.
79      *
80      * @param series the series index (zero-based).
81      * @param item the item index (zero-based).
82      *
83      * @return The value.
84      */
85     public Number JavaDoc getEndX(int series, int item);
86
87     /**
88      * Returns the end x-value (as a double primitive) for an item within a
89      * series.
90      *
91      * @param series the series index (zero-based).
92      * @param item the item index (zero-based).
93      *
94      * @return The end x-value.
95      */
96     public double getEndXValue(int series, int item);
97
98     /**
99      * Returns the starting Y value for the specified series and item.
100      *
101      * @param series the series index (zero-based).
102      * @param item the item index (zero-based).
103      *
104      * @return The value.
105      */
106     public Number JavaDoc getStartY(int series, int item);
107
108     /**
109      * Returns the start y-value (as a double primitive) for an item within a
110      * series.
111      *
112      * @param series the series index (zero-based).
113      * @param item the item index (zero-based).
114      *
115      * @return The start y-value.
116      */
117     public double getStartYValue(int series, int item);
118
119     /**
120      * Returns the ending Y value for the specified series and item.
121      *
122      * @param series the series index (zero-based).
123      * @param item the item index (zero-based).
124      *
125      * @return The value.
126      */
127     public Number JavaDoc getEndY(int series, int item);
128
129     /**
130      * Returns the end y-value (as a double primitive) for an item within a
131      * series.
132      *
133      * @param series the series index (zero-based).
134      * @param item the item index (zero-based).
135      *
136      * @return The end y-value.
137      */
138     public double getEndYValue(int series, int item);
139
140 }
141
Popular Tags