Source for org.jfree.data.RangeInfo

   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:  * RangeInfo.java
  29:  * --------------
  30:  * (C) Copyright 2000-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes (from 18-Sep-2001)
  36:  * --------------------------
  37:  * 18-Sep-2001 : Added standard header and fixed DOS encoding problem (DG);
  38:  * 15-Nov-2001 : Moved to package com.jrefinery.data.* (DG);
  39:  *               Updated Javadoc comments (DG);
  40:  * 22-Apr-2002 : Added getValueRange() method (DG);
  41:  * 17-Nov-2004 : Replaced getMinimumRangeValue() --> getRangeLowerBound(),
  42:  *               getMaximumRangeValue() --> getRangeUpperBound(),
  43:  *               getValueRange() --> getRangeBounds().
  44:  * 11-Jan-2005 : Removed deprecated code in preparation for the 1.0.0 
  45:  *               release (DG);
  46:  *
  47:  */
  48: 
  49: package org.jfree.data;
  50: 
  51: /**
  52:  * An interface (optional) that can be implemented by a dataset to assist in 
  53:  * determining the minimum and maximum values.  See also {@link DomainInfo}.
  54:  */
  55: public interface RangeInfo {
  56: 
  57:     /**
  58:      * Returns the minimum y-value in the dataset.
  59:      *
  60:      * @param includeInterval  a flag that determines whether or not the
  61:      *                         y-interval is taken into account.
  62:      * 
  63:      * @return The minimum value.
  64:      */
  65:     public double getRangeLowerBound(boolean includeInterval);
  66: 
  67:     /**
  68:      * Returns the maximum y-value in the dataset.
  69:      *
  70:      * @param includeInterval  a flag that determines whether or not the
  71:      *                         y-interval is taken into account.
  72:      * 
  73:      * @return The maximum value.
  74:      */
  75:     public double getRangeUpperBound(boolean includeInterval);
  76: 
  77:     /**
  78:      * Returns the range of the values in this dataset's range.
  79:      *
  80:      * @param includeInterval  a flag that determines whether or not the
  81:      *                         y-interval is taken into account.
  82:      * 
  83:      * @return The range.
  84:      */
  85:     public Range getRangeBounds(boolean includeInterval);
  86: 
  87: }