Source for org.jfree.data.contour.ContourDataset

   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:  * ContourDataset.java
  29:  * -------------------
  30:  * (C) Copyright 2002-2007, by David M. O'Donnell and Contributors.
  31:  *
  32:  * Original Author:  David M. O'Donnell;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: ContourDataset.java,v 1.2.2.3 2007/01/31 15:56:19 mungady Exp $
  36:  *
  37:  * Changes (from 23-Jan-2003)
  38:  * --------------------------
  39:  * 23-Jan-2003 : Added standard header (DG);
  40:  * 17-Jan-2004 : Added methods from DefaultContourDataset that are referenced 
  41:  *               by ContourPlot.  See bug 741048 (DG);
  42:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  43:  * 31-Jan-2007 : Deprecated (DG);
  44:  *
  45:  */
  46: 
  47: package org.jfree.data.contour;
  48: 
  49: import org.jfree.chart.plot.XYPlot;
  50: import org.jfree.chart.renderer.xy.XYBlockRenderer;
  51: import org.jfree.data.Range;
  52: import org.jfree.data.xy.XYZDataset;
  53: 
  54: /**
  55:  * The interface through which JFreeChart obtains data in the form of (x, y, z) 
  56:  * items - used for XY and XYZ plots.
  57:  * 
  58:  * @deprecated This class is no longer supported.  If you are creating
  59:  *     contour plots, please try to use {@link XYPlot} and 
  60:  *     {@link XYBlockRenderer}.
  61:  */
  62: public interface ContourDataset extends XYZDataset {
  63: 
  64:     /**
  65:      * Returns the smallest Z data value.
  66:      *
  67:      * @return The minimum Z value.
  68:      */
  69:     public double getMinZValue();
  70: 
  71:     /**
  72:      * Returns the largest Z data value.
  73:      *
  74:      * @return The maximum Z value.
  75:      */
  76:     public double getMaxZValue();
  77: 
  78:     /**
  79:      * Returns the array of Numbers representing the x data values.
  80:      *
  81:      * @return The array of x values.
  82:      */
  83:     public Number[] getXValues();
  84: 
  85:     /**
  86:      * Returns the array of Numbers representing the y data values.
  87:      *
  88:      * @return The array of y values.
  89:      */
  90:     public Number[] getYValues();
  91: 
  92:     /**
  93:      * Returns the array of Numbers representing the z data values.
  94:      *
  95:      * @return The array of z values.
  96:      */
  97:     public Number[] getZValues();
  98: 
  99:     /**
 100:      * Returns an int array contain the index into the x values.
 101:      *
 102:      * @return The X values.
 103:      */
 104:     public int[] indexX();
 105:     
 106:     /**
 107:      * Returns the index of the xvalues.
 108:      *
 109:      * @return The x values.
 110:      */
 111:     public int[] getXIndices();
 112: 
 113:     /**
 114:      * Returns the maximum z-value within visible region of plot.
 115:      *
 116:      * @param x  the x-value.
 117:      * @param y  the y-value.
 118:      *
 119:      * @return The maximum z-value.
 120:      */
 121:     public Range getZValueRange(Range x, Range y);
 122: 
 123:     /**
 124:      * Returns true if axis are dates.
 125:      *
 126:      * @param axisNumber  the axis where 0-x, 1-y, and 2-z.
 127:      *
 128:      * @return <code>true</code> or <code>false</code>.
 129:      */
 130:     public boolean isDateAxis(int axisNumber);
 131: 
 132: }