Source for org.jfree.data.xy.XIntervalDataItem

   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:  * XIntervalDataItem.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:  * $Id: XIntervalDataItem.java,v 1.1.2.2 2007/02/02 11:01:09 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 20-Oct-2006 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.data.xy;
  44: 
  45: import org.jfree.data.ComparableObjectItem;
  46: 
  47: /**
  48:  * An item representing data in the form (x, x-low, x-high, y).
  49:  *
  50:  * @since 1.0.3
  51:  */
  52: public class XIntervalDataItem extends ComparableObjectItem {
  53: 
  54:     /** 
  55:      * Creates a new instance of <code>XIntervalDataItem</code>.
  56:      *
  57:      * @param x  the x-value.
  58:      * @param xLow  the lower bound of the x-interval.
  59:      * @param xHigh  the upper bound of the x-interval.
  60:      * @param y  the y-value.
  61:      */
  62:     public XIntervalDataItem(double x, double xLow, double xHigh, double y) {
  63:         super(new Double(x), new YWithXInterval(y, xLow, xHigh));
  64:     }
  65:     
  66:     /**
  67:      * Returns the x-value.
  68:      *
  69:      * @return The x-value (never <code>null</code>).
  70:      */
  71:     public Number getX() {
  72:         return (Number) getComparable();
  73:     }
  74:     
  75:     /**
  76:      * Returns the y-value.
  77:      *
  78:      * @return The y-value.
  79:      */
  80:     public double getYValue() {
  81:         YWithXInterval interval = (YWithXInterval) getObject();
  82:         if (interval != null) {
  83:             return interval.getY();
  84:         }
  85:         else {
  86:             return Double.NaN;
  87:         }
  88:     }
  89:     
  90:     /**
  91:      * Returns the lower bound of the x-interval.
  92:      *
  93:      * @return The lower bound of the x-interval.
  94:      */
  95:     public double getXLowValue() {
  96:         YWithXInterval interval = (YWithXInterval) getObject();
  97:         if (interval != null) {
  98:             return interval.getXLow();
  99:         }
 100:         else {
 101:             return Double.NaN;
 102:         }
 103:     }
 104:     
 105:     /**
 106:      * Returns the upper bound of the x-interval.
 107:      *
 108:      * @return The upper bound of the x-interval.
 109:      */
 110:     public double getXHighValue() {
 111:         YWithXInterval interval = (YWithXInterval) getObject();
 112:         if (interval != null) {
 113:             return interval.getXHigh();
 114:         }
 115:         else {
 116:             return Double.NaN;
 117:         }
 118:     }
 119:     
 120: }