KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > RangeInfo


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