Source for org.jfree.data.xy.IntervalXYZDataset

   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:  * IntervalXYZDataset.java
  29:  * -----------------------
  30:  * (C) Copyright 2001-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 31-Oct-2001 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.data.xy;
  42: 
  43: 
  44: /**
  45:  * An extension of the {@link XYZDataset} interface that allows a range of data 
  46:  * to be defined for any of the X values, the Y values, and the Z values.
  47:  */
  48: public interface IntervalXYZDataset extends XYZDataset {
  49: 
  50:     /**
  51:      * Returns the starting X value for the specified series and item.
  52:      *
  53:      * @param series  the series (zero-based index).
  54:      * @param item  the item within a series (zero-based index).
  55:      *
  56:      * @return The starting X value for the specified series and item.
  57:      */
  58:     public Number getStartXValue(int series, int item);
  59: 
  60:     /**
  61:      * Returns the ending X value for the specified series and item.
  62:      *
  63:      * @param series  the series (zero-based index).
  64:      * @param item  the item within a series (zero-based index).
  65:      *
  66:      * @return The ending X value for the specified series and item.
  67:      */
  68:     public Number getEndXValue(int series, int item);
  69: 
  70:     /**
  71:      * Returns the starting Y value for the specified series and item.
  72:      *
  73:      * @param series  the series (zero-based index).
  74:      * @param item  the item within a series (zero-based index).
  75:      *
  76:      * @return The starting Y value for the specified series and item.
  77:      */
  78:     public Number getStartYValue(int series, int item);
  79: 
  80:     /**
  81:      * Returns the ending Y value for the specified series and item.
  82:      *
  83:      * @param series  the series (zero-based index).
  84:      * @param item  the item within a series (zero-based index).
  85:      *
  86:      * @return The ending Y value for the specified series and item.
  87:      */
  88:     public Number getEndYValue(int series, int item);
  89: 
  90:     /**
  91:      * Returns the starting Z value for the specified series and item.
  92:      *
  93:      * @param series  the series (zero-based index).
  94:      * @param item  the item within a series (zero-based index).
  95:      *
  96:      * @return The starting Z value for the specified series and item.
  97:      */
  98:     public Number getStartZValue(int series, int item);
  99: 
 100:     /**
 101:      * Returns the ending Z value for the specified series and item.
 102:      *
 103:      * @param series  the series (zero-based index).
 104:      * @param item  the item within a series (zero-based index).
 105:      *
 106:      * @return The ending Z value for the specified series and item.
 107:      */
 108:     public Number getEndZValue(int series, int item);
 109: 
 110: }