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 * XYIntervalDataItem.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, x-low, x-high, y, y-low, y-high).
043 */
044public class XYIntervalDataItem extends ComparableObjectItem {
045
046    /**
047     * Creates a new instance of {@code XYIntervalItem}.
048     *
049     * @param x  the x-value.
050     * @param xLow  the lower bound of the x-interval.
051     * @param xHigh  the upper bound of the x-interval.
052     * @param y  the y-value.
053     * @param yLow  the lower bound of the y-interval.
054     * @param yHigh  the upper bound of the y-interval.
055     */
056    public XYIntervalDataItem(double x, double xLow, double xHigh, double y,
057            double yLow, double yHigh) {
058        super(x, new XYInterval(xLow, xHigh, y, yLow, yHigh));
059    }
060
061    /**
062     * Returns the x-value.
063     *
064     * @return The x-value (never {@code null}).
065     */
066    public Double getX() {
067        return (Double) getComparable();
068    }
069
070    /**
071     * Returns the y-value.
072     *
073     * @return The y-value.
074     */
075    public double getYValue() {
076        XYInterval interval = (XYInterval) getObject();
077        if (interval != null) {
078            return interval.getY();
079        }
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        XYInterval interval = (XYInterval) getObject();
092        if (interval != null) {
093            return interval.getXLow();
094        }
095        else {
096            return Double.NaN;
097        }
098    }
099
100    /**
101     * Returns the upper bound of the x-interval.
102     *
103     * @return The upper bound of the x-interval.
104     */
105    public double getXHighValue() {
106        XYInterval interval = (XYInterval) getObject();
107        if (interval != null) {
108            return interval.getXHigh();
109        }
110        else {
111            return Double.NaN;
112        }
113    }
114
115    /**
116     * Returns the lower bound of the y-interval.
117     *
118     * @return The lower bound of the y-interval.
119     */
120    public double getYLowValue() {
121        XYInterval interval = (XYInterval) getObject();
122        if (interval != null) {
123            return interval.getYLow();
124        }
125        else {
126            return Double.NaN;
127        }
128    }
129
130    /**
131     * Returns the upper bound of the y-interval.
132     *
133     * @return The upper bound of the y-interval.
134     */
135    public double getYHighValue() {
136        XYInterval interval = (XYInterval) getObject();
137        if (interval != null) {
138            return interval.getYHigh();
139        }
140        else {
141            return Double.NaN;
142        }
143    }
144
145}