KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > 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 License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -------------------
27  * TickUnitSource.java
28  * -------------------
29  * (C) Copyright 2003, 2004, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): -;
33  *
34  * $Id: TickUnitSource.java,v 1.2 2005/02/28 11:45:17 mungady Exp $
35  *
36  * Changes
37  * -------
38  * 23-Sep-2003 : Version 1 (DG);
39  *
40  */

41
42 package org.jfree.chart.axis;
43
44 /**
45  * An interface used by the {@link DateAxis} and {@link NumberAxis} classes to
46  * obtain a suitable {@link TickUnit}.
47  */

48 public interface TickUnitSource {
49
50     /**
51      * Returns a tick unit that is larger than the supplied unit.
52      *
53      * @param unit the unit.
54      *
55      * @return A tick unit that is larger than the supplied unit.
56      */

57     public TickUnit getLargerTickUnit(TickUnit unit);
58
59     /**
60      * Returns the tick unit in the collection that is greater than or equal
61      * to (in size) the specified unit.
62      *
63      * @param unit the unit.
64      *
65      * @return A unit from the collection.
66      */

67     public TickUnit getCeilingTickUnit(TickUnit unit);
68
69     /**
70      * Returns the tick unit in the collection that is greater than or equal
71      * to the specified size.
72      *
73      * @param size the size.
74      *
75      * @return A unit from the collection.
76      */

77     public TickUnit getCeilingTickUnit(double size);
78     
79 }
80
Popular Tags