001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2014, 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ---------------------
028 * XYIntervalSeries.java
029 * ---------------------
030 * (C) Copyright 2006-2014, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 20-Oct-2006 : Version 1 (DG);
038 * 13-Feb-2007 : Added several new accessor methods (DG);
039 * 09-Jan-2014 : Added add(XYIntervalDataItem, boolean) method (DG);
040 *
041 */
042
043package org.jfree.data.xy;
044
045import org.jfree.data.ComparableObjectItem;
046import org.jfree.data.ComparableObjectSeries;
047import org.jfree.data.general.SeriesChangeEvent;
048
049/**
050 * A list of (x, x-low, x-high, y, y-low, y-high) data items.
051 *
052 * @since 1.0.3
053 *
054 * @see XYIntervalSeriesCollection
055 */
056public class XYIntervalSeries extends ComparableObjectSeries {
057
058    /**
059     * Creates a new empty series.  By default, items added to the series will
060     * be sorted into ascending order by x-value, and duplicate x-values will
061     * be allowed (these defaults can be modified with another constructor).
062     *
063     * @param key  the series key (<code>null</code> not permitted).
064     */
065    public XYIntervalSeries(Comparable key) {
066        this(key, true, true);
067    }
068
069    /**
070     * Constructs a new xy-series that contains no data.  You can specify
071     * whether or not duplicate x-values are allowed for the series.
072     *
073     * @param key  the series key (<code>null</code> not permitted).
074     * @param autoSort  a flag that controls whether or not the items in the
075     *                  series are sorted.
076     * @param allowDuplicateXValues  a flag that controls whether duplicate
077     *                               x-values are allowed.
078     */
079    public XYIntervalSeries(Comparable key, boolean autoSort,
080            boolean allowDuplicateXValues) {
081        super(key, autoSort, allowDuplicateXValues);
082    }
083
084    /**
085     * Adds a data item to the series and sends a {@link SeriesChangeEvent} to 
086     * all registered listeners.
087     *
088     * @param x  the x-value.
089     * @param xLow  the lower bound of the x-interval.
090     * @param xHigh  the upper bound of the x-interval.
091     * @param y  the y-value.
092     * @param yLow  the lower bound of the y-interval.
093     * @param yHigh  the upper bound of the y-interval.
094     */
095    public void add(double x, double xLow, double xHigh, double y, double yLow,
096            double yHigh) {
097        add(new XYIntervalDataItem(x, xLow, xHigh, y, yLow, yHigh), true);
098    }
099    
100    /**
101     * Adds a data item to the series and, if requested, sends a 
102     * {@link SeriesChangeEvent} to all registered listeners.
103     * 
104     * @param item  the data item (<code>null</code> not permitted).
105     * @param notify  notify listeners?
106     * 
107     * @since 1.0.18
108     */
109    public void add(XYIntervalDataItem item, boolean notify) {
110        super.add(item, notify);
111    }
112
113    /**
114     * Returns the x-value for the specified item.
115     *
116     * @param index  the item index.
117     *
118     * @return The x-value (never <code>null</code>).
119     */
120    public Number getX(int index) {
121        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
122        return item.getX();
123    }
124
125    /**
126     * Returns the lower bound of the x-interval for the specified item in the
127     * series.
128     *
129     * @param index  the item index.
130     *
131     * @return The lower bound of the x-interval.
132     *
133     * @since 1.0.5
134     */
135    public double getXLowValue(int index) {
136        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
137        return item.getXLowValue();
138    }
139
140    /**
141     * Returns the upper bound of the x-interval for the specified item in the
142     * series.
143     *
144     * @param index  the item index.
145     *
146     * @return The upper bound of the x-interval.
147     *
148     * @since 1.0.5
149     */
150    public double getXHighValue(int index) {
151        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
152        return item.getXHighValue();
153    }
154
155    /**
156     * Returns the y-value for the specified item.
157     *
158     * @param index  the item index.
159     *
160     * @return The y-value.
161     */
162    public double getYValue(int index) {
163        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
164        return item.getYValue();
165    }
166
167    /**
168     * Returns the lower bound of the Y-interval for the specified item in the
169     * series.
170     *
171     * @param index  the item index.
172     *
173     * @return The lower bound of the Y-interval.
174     *
175     * @since 1.0.5
176     */
177    public double getYLowValue(int index) {
178        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
179        return item.getYLowValue();
180    }
181
182    /**
183     * Returns the upper bound of the y-interval for the specified item in the
184     * series.
185     *
186     * @param index  the item index.
187     *
188     * @return The upper bound of the y-interval.
189     *
190     * @since 1.0.5
191     */
192    public double getYHighValue(int index) {
193        XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
194        return item.getYHighValue();
195    }
196
197    /**
198     * Returns the data item at the specified index.
199     *
200     * @param index  the item index.
201     *
202     * @return The data item.
203     */
204    @Override
205    public ComparableObjectItem getDataItem(int index) {
206        return super.getDataItem(index);
207    }
208
209}