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