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