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