Source for org.jfree.data.xy.AbstractXYDataset

   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:  * AbstractXYDataset.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: AbstractXYDataset.java,v 1.2.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 getX() with getXValue() and getY() with 
  41:  *               getYValue() (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: import org.jfree.data.DomainOrder;
  49: import org.jfree.data.general.AbstractSeriesDataset;
  50: 
  51: /**
  52:  * An base class that you can use to create new implementations of the 
  53:  * {@link XYDataset} interface.
  54:  */
  55: public abstract class AbstractXYDataset extends AbstractSeriesDataset 
  56:                                         implements XYDataset {
  57: 
  58:     /**
  59:      * Returns the order of the domain (X) values.
  60:      * 
  61:      * @return The domain order.
  62:      */
  63:     public DomainOrder getDomainOrder() {
  64:         return DomainOrder.NONE;
  65:     }
  66:     
  67:     /**
  68:      * Returns the x-value (as a double primitive) for an item within a series.
  69:      * 
  70:      * @param series  the series index (zero-based).
  71:      * @param item  the item index (zero-based).
  72:      * 
  73:      * @return The value.
  74:      */
  75:     public double getXValue(int series, int item) {
  76:         double result = Double.NaN;
  77:         Number x = getX(series, item);
  78:         if (x != null) {
  79:             result = x.doubleValue();   
  80:         }
  81:         return result;   
  82:     }
  83: 
  84:     /**
  85:      * Returns the y-value (as a double primitive) for an item within a series.
  86:      * 
  87:      * @param series  the series index (zero-based).
  88:      * @param item  the item index (zero-based).
  89:      * 
  90:      * @return The value.
  91:      */
  92:     public double getYValue(int series, int item) {
  93:         double result = Double.NaN;
  94:         Number y = getY(series, item);
  95:         if (y != null) {
  96:             result = y.doubleValue();   
  97:         }
  98:         return result;   
  99:     }
 100: 
 101: }