Source for org.jfree.data.xy.AbstractIntervalXYDataset

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, 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:  * AbstractIntervalXYDataset.java
  29:  * ------------------------------
  30:  * (C) Copyright 2004-2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited).
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: AbstractIntervalXYDataset.java,v 1.3.2.1 2005/10/25 21:36:51 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 05-May-2004 : Version 1 (DG);
  40:  * 15-Jul-2004 : Switched getStartX() and getStartXValue() methods and 
  41:  *               others (DG);
  42:  * 18-Aug-2004 : Moved from org.jfree.data --> org.jfree.data.xy (DG);
  43:  * 
  44:  */
  45: 
  46: package org.jfree.data.xy;
  47: 
  48: 
  49: /**
  50:  * An base class that you can use to create new implementations of the 
  51:  * {@link IntervalXYDataset} interface.
  52:  */
  53: public abstract class AbstractIntervalXYDataset extends AbstractXYDataset 
  54:                                                 implements IntervalXYDataset {
  55: 
  56:     /**
  57:      * Returns the start x-value (as a double primitive) for an item within a 
  58:      * series.
  59:      * 
  60:      * @param series  the series index (zero-based).
  61:      * @param item  the item index (zero-based).
  62:      * 
  63:      * @return The value.
  64:      */
  65:     public double getStartXValue(int series, int item) {
  66:         double result = Double.NaN;
  67:         Number x = getStartX(series, item);
  68:         if (x != null) {
  69:             result = x.doubleValue();   
  70:         }
  71:         return result;   
  72:     }
  73: 
  74:     /**
  75:      * Returns the end x-value (as a double primitive) for an item within a 
  76:      * series.
  77:      * 
  78:      * @param series  the series index (zero-based).
  79:      * @param item  the item index (zero-based).
  80:      * 
  81:      * @return The value.
  82:      */
  83:     public double getEndXValue(int series, int item) {
  84:         double result = Double.NaN;
  85:         Number x = getEndX(series, item);
  86:         if (x != null) {
  87:             result = x.doubleValue();   
  88:         }
  89:         return result;   
  90:     }
  91: 
  92:     /**
  93:      * Returns the start y-value (as a double primitive) for an item within a 
  94:      * series.
  95:      * 
  96:      * @param series  the series index (zero-based).
  97:      * @param item  the item index (zero-based).
  98:      * 
  99:      * @return The value.
 100:      */
 101:     public double getStartYValue(int series, int item) {
 102:         double result = Double.NaN;
 103:         Number y = getStartY(series, item);
 104:         if (y != null) {
 105:             result = y.doubleValue();   
 106:         }
 107:         return result;   
 108:     }
 109: 
 110:     /**
 111:      * Returns the end y-value (as a double primitive) for an item within a 
 112:      * series.
 113:      * 
 114:      * @param series  the series (zero-based index).
 115:      * @param item  the item (zero-based index).
 116:      * 
 117:      * @return The value.
 118:      */
 119:     public double getEndYValue(int series, int item) {
 120:         double result = Double.NaN;
 121:         Number y = getEndY(series, item);
 122:         if (y != null) {
 123:             result = y.doubleValue();   
 124:         }
 125:         return result;   
 126:     }
 127: 
 128: }