001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, 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 * YIntervalSeries.java
029 * --------------------
030 * (C) Copyright 2006-present, 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, y, y-low, y-high) data items.
045 *
046 * @see YIntervalSeriesCollection
047 */
048public class YIntervalSeries extends ComparableObjectSeries {
049
050    /**
051     * Creates a new empty series.  By default, items added to the series will
052     * be sorted into ascending order by x-value, and duplicate x-values will
053     * be allowed (these defaults can be modified with another constructor.
054     *
055     * @param key  the series key ({@code null} not permitted).
056     */
057    public YIntervalSeries(Comparable key) {
058        this(key, true, true);
059    }
060
061    /**
062     * Constructs a new xy-series that contains no data.  You can specify
063     * whether or not duplicate x-values are allowed for the series.
064     *
065     * @param key  the series key ({@code null} not permitted).
066     * @param autoSort  a flag that controls whether or not the items in the
067     *                  series are sorted.
068     * @param allowDuplicateXValues  a flag that controls whether duplicate
069     *                               x-values are allowed.
070     */
071    public YIntervalSeries(Comparable key, boolean autoSort,
072            boolean allowDuplicateXValues) {
073        super(key, autoSort, allowDuplicateXValues);
074    }
075
076    /**
077     * Adds a data item to the series and sends a {@link SeriesChangeEvent} to 
078     * all registered listeners.
079     *
080     * @param x  the x-value.
081     * @param y  the y-value.
082     * @param yLow  the lower bound of the y-interval.
083     * @param yHigh  the upper bound of the y-interval.
084     */
085    public void add(double x, double y, double yLow, double yHigh) {
086        add(new YIntervalDataItem(x, y, yLow, yHigh), true);
087    }
088    
089    /**
090     * Adds a data item to the series and, if requested, sends a 
091     * {@link SeriesChangeEvent} to all registered listeners.
092     * 
093     * @param item  the data item ({@code null} not permitted).
094     * @param notify  notify listeners?
095     */
096    public void add(YIntervalDataItem item, boolean notify) {
097        super.add(item, notify);
098    }
099
100    /**
101     * Returns the x-value for the specified item.
102     *
103     * @param index  the item index.
104     *
105     * @return The x-value (never {@code null}).
106     */
107    public Number getX(int index) {
108        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
109        return item.getX();
110    }
111
112    /**
113     * Returns the y-value for the specified item.
114     *
115     * @param index  the item index.
116     *
117     * @return The y-value.
118     */
119    public double getYValue(int index) {
120        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
121        return item.getYValue();
122    }
123
124    /**
125     * Returns the lower bound of the Y-interval for the specified item in the
126     * series.
127     *
128     * @param index  the item index.
129     *
130     * @return The lower bound of the Y-interval.
131     */
132    public double getYLowValue(int index) {
133        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
134        return item.getYLowValue();
135    }
136
137    /**
138     * Returns the upper bound of the y-interval for the specified item in the
139     * series.
140     *
141     * @param index  the item index.
142     *
143     * @return The upper bound of the y-interval.
144     */
145    public double getYHighValue(int index) {
146        YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
147        return item.getYHighValue();
148    }
149
150    /**
151     * Returns the data item at the specified index.
152     *
153     * @param index  the item index.
154     *
155     * @return The data item.
156     */
157    @Override
158    public ComparableObjectItem getDataItem(int index) {
159        return super.getDataItem(index);
160    }
161
162}