001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, 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-2007, 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 * Changes
036 * -------
037 * 18-Oct-2001 : Version 1, thanks to Mark Watson (DG);
038 * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc (DG);
039 * 06-May-2004 : Added methods that return double primitives (DG);
040 *
041 */
042
043package org.jfree.data.xy;
044
045
046/**
047 * An extension of the {@link XYDataset} interface that allows a range of data 
048 * to be defined for the X values, the Y values, or both the X and Y values.  
049 * This interface is used to support (among other things) bar plots against 
050 * numerical axes.
051 */
052public interface IntervalXYDataset extends XYDataset {
053
054    /**
055     * Returns the starting X value for the specified series and item.
056     *
057     * @param series  the series index (zero-based).
058     * @param item  the item index (zero-based).
059     *
060     * @return The value.
061     */
062    public Number getStartX(int series, int item);
063
064    /**
065     * Returns the start x-value (as a double primitive) for an item within a 
066     * series.
067     * 
068     * @param series  the series (zero-based index).
069     * @param item  the item (zero-based index).
070     * 
071     * @return The start x-value.
072     */
073    public double getStartXValue(int series, int item);
074
075    /**
076     * Returns the ending X value for the specified series and item.
077     *
078     * @param series  the series index (zero-based).
079     * @param item  the item index (zero-based).
080     *
081     * @return The value.
082     */
083    public Number getEndX(int series, int item);
084
085    /**
086     * Returns the end x-value (as a double primitive) for an item within a 
087     * series.
088     * 
089     * @param series  the series index (zero-based).
090     * @param item  the item index (zero-based).
091     * 
092     * @return The end x-value.
093     */
094    public double getEndXValue(int series, int item);
095
096    /**
097     * Returns the starting Y value for the specified series and item.
098     *
099     * @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}