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 * YIntervalSeries.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 * 20-Feb-2007 : Added getYHighValue() and getYLowValue() methods (DG);
039 * 09-Jan-2014 : Added add(YIntervalDataItem, 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, y, y-low, y-high) data items.
051 *
052 * @since 1.0.3
053 *
054 * @see YIntervalSeriesCollection
055 */
056public class YIntervalSeries 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 YIntervalSeries(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 YIntervalSeries(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 y  the y-value.
090     * @param yLow  the lower bound of the y-interval.
091     * @param yHigh  the upper bound of the y-interval.
092     */
093    public void add(double x, double y, double yLow, double yHigh) {
094        add(new YIntervalDataItem(x, y, yLow, yHigh), true);
095    }
096    
097    /**
098     * Adds a data item to the series and, if requested, sends a 
099     * {@link SeriesChangeEvent} to all registered listeners.
100     * 
101     * @param item  the data item (<code>null</code> not permitted).
102     * @param notify  notify listeners?
103     * 
104     * @since 1.0.18
105     */
106    public void add(YIntervalDataItem item, boolean notify) {
107        super.add(item, notify);
108    }
109
110    /**
111     * Returns the x-value for the specified item.
112     *
113     * @param index  the item index.
114     *
115     * @return The x-value (never <code>null</code>).
116     */
117    public Number getX(int index) {
118        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
119        return item.getX();
120    }
121
122    /**
123     * Returns the y-value for the specified item.
124     *
125     * @param index  the item index.
126     *
127     * @return The y-value.
128     */
129    public double getYValue(int index) {
130        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
131        return item.getYValue();
132    }
133
134    /**
135     * Returns the lower bound of the Y-interval for the specified item in the
136     * series.
137     *
138     * @param index  the item index.
139     *
140     * @return The lower bound of the Y-interval.
141     *
142     * @since 1.0.5
143     */
144    public double getYLowValue(int index) {
145        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
146        return item.getYLowValue();
147    }
148
149    /**
150     * Returns the upper bound of the y-interval for the specified item in the
151     * series.
152     *
153     * @param index  the item index.
154     *
155     * @return The upper bound of the y-interval.
156     *
157     * @since 1.0.5
158     */
159    public double getYHighValue(int index) {
160        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
161        return item.getYHighValue();
162    }
163
164    /**
165     * Returns the data item at the specified index.
166     *
167     * @param index  the item index.
168     *
169     * @return The data item.
170     */
171    @Override
172    public ComparableObjectItem getDataItem(int index) {
173        return super.getDataItem(index);
174    }
175
176}