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