Source for org.jfree.chart.axis.TickUnitSource

   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:  * TickUnitSource.java
  29:  * -------------------
  30:  * (C) Copyright 2003, 2004, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: TickUnitSource.java,v 1.2.2.1 2005/10/25 20:37:34 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 23-Sep-2003 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.axis;
  44: 
  45: /**
  46:  * An interface used by the {@link DateAxis} and {@link NumberAxis} classes to 
  47:  * obtain a suitable {@link TickUnit}.
  48:  */
  49: public interface TickUnitSource {
  50: 
  51:     /**
  52:      * Returns a tick unit that is larger than the supplied unit.
  53:      *
  54:      * @param unit   the unit.
  55:      *
  56:      * @return A tick unit that is larger than the supplied unit.
  57:      */
  58:     public TickUnit getLargerTickUnit(TickUnit unit);
  59: 
  60:     /**
  61:      * Returns the tick unit in the collection that is greater than or equal
  62:      * to (in size) the specified unit.
  63:      *
  64:      * @param unit  the unit.
  65:      *
  66:      * @return A unit from the collection.
  67:      */
  68:     public TickUnit getCeilingTickUnit(TickUnit unit);
  69: 
  70:     /**
  71:      * Returns the tick unit in the collection that is greater than or equal
  72:      * to the specified size.
  73:      *
  74:      * @param size  the size.
  75:      *
  76:      * @return A unit from the collection.
  77:      */
  78:     public TickUnit getCeilingTickUnit(double size);
  79:     
  80: }