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 * XIntervalDataItem.java
029 * ----------------------
030 * (C) Copyright 2006-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 20-Oct-2006 : Version 1 (DG);
038 *
039 */
040
041package org.jfree.data.xy;
042
043import org.jfree.data.ComparableObjectItem;
044
045/**
046 * An item representing data in the form (x, x-low, x-high, y).
047 */
048public class XIntervalDataItem extends ComparableObjectItem {
049
050    /**
051     * Creates a new instance of {@code XIntervalDataItem}.
052     *
053     * @param x  the x-value.
054     * @param xLow  the lower bound of the x-interval.
055     * @param xHigh  the upper bound of the x-interval.
056     * @param y  the y-value.
057     */
058    public XIntervalDataItem(double x, double xLow, double xHigh, double y) {
059        super(x, new YWithXInterval(y, xLow, xHigh));
060    }
061
062    /**
063     * Returns the x-value.
064     *
065     * @return The x-value (never {@code null}).
066     */
067    public Number getX() {
068        return (Number) getComparable();
069    }
070
071    /**
072     * Returns the y-value.
073     *
074     * @return The y-value.
075     */
076    public double getYValue() {
077        YWithXInterval interval = (YWithXInterval) getObject();
078        if (interval != null) {
079            return interval.getY();
080        } else {
081            return Double.NaN;
082        }
083    }
084
085    /**
086     * Returns the lower bound of the x-interval.
087     *
088     * @return The lower bound of the x-interval.
089     */
090    public double getXLowValue() {
091        YWithXInterval interval = (YWithXInterval) getObject();
092        if (interval != null) {
093            return interval.getXLow();
094        } else {
095            return Double.NaN;
096        }
097    }
098
099    /**
100     * Returns the upper bound of the x-interval.
101     *
102     * @return The upper bound of the x-interval.
103     */
104    public double getXHighValue() {
105        YWithXInterval interval = (YWithXInterval) getObject();
106        if (interval != null) {
107            return interval.getXHigh();
108        } else {
109            return Double.NaN;
110        }
111    }
112
113}