Source for org.jfree.data.xy.YIntervalDataItem

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ----------------------
  28:  * YIntervalDataItem.java
  29:  * ----------------------
  30:  * (C) Copyright 2006, 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 20-Oct-2006 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.data.xy;
  42: 
  43: import org.jfree.data.ComparableObjectItem;
  44: 
  45: /**
  46:  * An item representing data in the form (x, y, y-low, y-high).
  47:  *
  48:  * @since 1.0.3
  49:  */
  50: public class YIntervalDataItem extends ComparableObjectItem {
  51: 
  52:     /** 
  53:      * Creates a new instance of <code>YIntervalItem</code>.
  54:      *
  55:      * @param x  the x-value.
  56:      * @param y  the y-value.
  57:      * @param yLow  the lower bound of the y-interval.
  58:      * @param yHigh  the upper bound of the y-interval.
  59:      */
  60:     public YIntervalDataItem(double x, double y, double yLow, double yHigh) {
  61:         super(new Double(x), new YInterval(y, yLow, yHigh));
  62:     }
  63:     
  64:     /**
  65:      * Returns the x-value.
  66:      *
  67:      * @return The x-value (never <code>null</code>).
  68:      */
  69:     public Double getX() {
  70:         return (Double) getComparable();
  71:     }
  72:     
  73:     /**
  74:      * Returns the y-value.
  75:      *
  76:      * @return The y-value.
  77:      */
  78:     public double getYValue() {
  79:         YInterval interval = (YInterval) getObject();
  80:         if (interval != null) {
  81:             return interval.getY();
  82:         }
  83:         else {
  84:             return Double.NaN;
  85:         }
  86:     }
  87:     
  88:     /**
  89:      * Returns the lower bound of the y-interval.
  90:      *
  91:      * @return The lower bound of the y-interval.
  92:      */
  93:     public double getYLowValue() {
  94:         YInterval interval = (YInterval) getObject();
  95:         if (interval != null) {
  96:             return interval.getYLow();
  97:         }
  98:         else {
  99:             return Double.NaN;
 100:         }
 101:     }
 102:     
 103:     /**
 104:      * Returns the upper bound of the y-interval.
 105:      *
 106:      * @return The upper bound of the y-interval.
 107:      */
 108:     public double getYHighValue() {
 109:         YInterval interval = (YInterval) getObject();
 110:         if (interval != null) {
 111:             return interval.getYHigh();
 112:         }
 113:         else {
 114:             return Double.NaN;
 115:         }
 116:     }
 117:     
 118: }