Source for org.jfree.data.xy.XYZDataset

   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:  * XYZDataset.java
  29:  * ---------------
  30:  * (C) Copyright 2001-2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: XYZDataset.java,v 1.2.2.1 2005/10/25 21:36:51 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 31-Oct-2001 : Initial version (DG);
  40:  * 05-May-2004 : Added getZ() method;
  41:  * 15-Jul-2004 : Switched getZ() and getZValue() methods (DG);
  42:  * 18-Aug-2004 : Moved from org.jfree.data --> org.jfree.data.xy (DG);
  43:  *
  44:  */
  45: package org.jfree.data.xy;
  46: 
  47: 
  48: /**
  49:  * The interface through which JFreeChart obtains data in the form of (x, y, z)
  50:  * items - used for XY and XYZ plots.
  51:  */
  52: public interface XYZDataset extends XYDataset {
  53: 
  54:     /**
  55:      * Returns the z-value for the specified series and item.
  56:      *
  57:      * @param series  the series index (zero-based).
  58:      * @param item  the item index (zero-based).
  59:      *
  60:      * @return The z-value (possibly <code>null</code>).
  61:      */
  62:     public Number getZ(int series, int item);
  63:     
  64:     /**
  65:      * Returns the z-value (as a double primitive) for an item within a series.
  66:      * 
  67:      * @param series  the series (zero-based index).
  68:      * @param item  the item (zero-based index).
  69:      * 
  70:      * @return The z-value.
  71:      */
  72:     public double getZValue(int series, int item);
  73: 
  74: }