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 * YIntervalDataItem.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;
040
041/**
042 * An item representing data in the form (x, y, y-low, y-high).
043 */
044public class YIntervalDataItem extends ComparableObjectItem {
045
046    /**
047     * Creates a new instance of {@code YIntervalDataItem}.
048     *
049     * @param x  the x-value.
050     * @param y  the y-value.
051     * @param yLow  the lower bound of the y-interval.
052     * @param yHigh  the upper bound of the y-interval.
053     */
054    public YIntervalDataItem(double x, double y, double yLow, double yHigh) {
055        super(x, new YInterval(y, yLow, yHigh));
056    }
057
058    /**
059     * Returns the x-value.
060     *
061     * @return The x-value (never {@code null}).
062     */
063    public Double getX() {
064        return (Double) getComparable();
065    }
066
067    /**
068     * Returns the y-value.
069     *
070     * @return The y-value.
071     */
072    public double getYValue() {
073        YInterval interval = (YInterval) getObject();
074        if (interval != null) {
075            return interval.getY();
076        }
077        else {
078            return Double.NaN;
079        }
080    }
081
082    /**
083     * Returns the lower bound of the y-interval.
084     *
085     * @return The lower bound of the y-interval.
086     */
087    public double getYLowValue() {
088        YInterval interval = (YInterval) getObject();
089        if (interval != null) {
090            return interval.getYLow();
091        }
092        else {
093            return Double.NaN;
094        }
095    }
096
097    /**
098     * Returns the upper bound of the y-interval.
099     *
100     * @return The upper bound of the y-interval.
101     */
102    public double getYHighValue() {
103        YInterval interval = (YInterval) getObject();
104        if (interval != null) {
105            return interval.getYHigh();
106        }
107        else {
108            return Double.NaN;
109        }
110    }
111
112}