Source for org.jfree.data.xy.AbstractXYZDataset

   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:  * AbstractXYZDataset.java
  29:  * -----------------------
  30:  * (C) Copyright 2004, 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited).
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 05-May-2004 : Version 1 (DG);
  38:  * 15-Jul-2004 : Switched getZ() and getZValue() (DG);
  39:  *
  40:  */
  41: 
  42: package org.jfree.data.xy;
  43: 
  44: /**
  45:  * An base class that you can use to create new implementations of the 
  46:  * {@link XYZDataset} interface.
  47:  */
  48: public abstract class AbstractXYZDataset extends AbstractXYDataset 
  49:                                          implements XYZDataset {
  50: 
  51:     /**
  52:      * Returns the z-value (as a double primitive) for an item within a series.
  53:      * 
  54:      * @param series  the series (zero-based index).
  55:      * @param item  the item (zero-based index).
  56:      * 
  57:      * @return The z-value.
  58:      */
  59:     public double getZValue(int series, int item) {
  60:         double result = Double.NaN;
  61:         Number z = getZ(series, item);
  62:         if (z != null) {
  63:             result = z.doubleValue();   
  64:         }
  65:         return result;   
  66:     }
  67: 
  68: }