001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006: *
007: * Project Info: http://www.jfree.org/jfreechart/index.html
008: *
009: * This library is free software; you can redistribute it and/or modify it
010: * under the terms of the GNU Lesser General Public License as published by
011: * the Free Software Foundation; either version 2.1 of the License, or
012: * (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but
015: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017: * License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022: * USA.
023: *
024: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * ----------------------
028: * IntervalXYDataset.java
029: * ----------------------
030: * (C) Copyright 2001-2004, by Object Refinery Limited and Contributors.
031: *
032: * Original Author: Mark Watson (www.markwatson.com);
033: * Contributor(s): David Gilbert (for Object Refinery Limited);
034: *
035: * $Id: IntervalXYDataset.java,v 1.2.2.1 2005/10/25 21:36:51 mungady Exp $
036: *
037: * Changes
038: * -------
039: * 18-Oct-2001 : Version 1, thanks to Mark Watson (DG);
040: * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc (DG);
041: * 06-May-2004 : Added methods that return double primitives (DG);
042: *
043: */
044:
045: package org.jfree.data.xy;
046:
047: /**
048: * An extension of the {@link XYDataset} interface that allows a range of data
049: * to be defined for the X values, the Y values, or both the X and Y values.
050: * This interface is used to support (among other things) bar plots against
051: * numerical axes.
052: */
053: public interface IntervalXYDataset extends XYDataset {
054:
055: /**
056: * Returns the starting X value for the specified series and item.
057: *
058: * @param series the series index (zero-based).
059: * @param item the item index (zero-based).
060: *
061: * @return The value.
062: */
063: public Number getStartX(int series, int item);
064:
065: /**
066: * Returns the start x-value (as a double primitive) for an item within a
067: * series.
068: *
069: * @param series the series (zero-based index).
070: * @param item the item (zero-based index).
071: *
072: * @return The start x-value.
073: */
074: public double getStartXValue(int series, int item);
075:
076: /**
077: * Returns the ending X value for the specified series and item.
078: *
079: * @param series the series index (zero-based).
080: * @param item the item index (zero-based).
081: *
082: * @return The value.
083: */
084: public Number getEndX(int series, int item);
085:
086: /**
087: * Returns the end x-value (as a double primitive) for an item within a
088: * series.
089: *
090: * @param series the series index (zero-based).
091: * @param item the item index (zero-based).
092: *
093: * @return The end x-value.
094: */
095: public double getEndXValue(int series, int item);
096:
097: /**
098: * Returns the starting Y value for the specified series and item.
099: *
100: * @param series the series index (zero-based).
101: * @param item the item index (zero-based).
102: *
103: * @return The value.
104: */
105: public Number getStartY(int series, int item);
106:
107: /**
108: * Returns the start y-value (as a double primitive) for an item within a
109: * series.
110: *
111: * @param series the series index (zero-based).
112: * @param item the item index (zero-based).
113: *
114: * @return The start y-value.
115: */
116: public double getStartYValue(int series, int item);
117:
118: /**
119: * Returns the ending Y value for the specified series and item.
120: *
121: * @param series the series index (zero-based).
122: * @param item the item index (zero-based).
123: *
124: * @return The value.
125: */
126: public Number getEndY(int series, int item);
127:
128: /**
129: * Returns the end y-value (as a double primitive) for an item within a
130: * series.
131: *
132: * @param series the series index (zero-based).
133: * @param item the item index (zero-based).
134: *
135: * @return The end y-value.
136: */
137: public double getEndYValue(int series, int item);
138:
139: }
|