KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > contour > ContourDataset


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  * ContourDataset.java
29  * -------------------
30  * (C) Copyright 2002-2004, by David M. O'Donnell and Contributors.
31  *
32  * Original Author: David M. O'Donnell;
33  * Contributor(s): David Gilbert (for Object Refinery Limited);
34  *
35  * $Id: ContourDataset.java,v 1.2.2.1 2005/10/25 21:30:20 mungady Exp $
36  *
37  * Changes (from 23-Jan-2003)
38  * --------------------------
39  * 23-Jan-2003 : Added standard header (DG);
40  * 17-Jan-2004 : Added methods from DefaultContourDataset that are referenced
41  * by ContourPlot. See bug 741048 (DG);
42  *
43  */
44
45 package org.jfree.data.contour;
46
47 import org.jfree.data.Range;
48 import org.jfree.data.xy.XYZDataset;
49
50 /**
51  * The interface through which JFreeChart obtains data in the form of (x, y, z)
52  * items - used for XY and XYZ plots.
53  *
54  * @author David M. O'Donnell
55  */
56 public interface ContourDataset extends XYZDataset {
57
58     /**
59      * Returns the smallest Z data value.
60      *
61      * @return The minimum Z value.
62      */
63     public double getMinZValue();
64
65     /**
66      * Returns the largest Z data value.
67      *
68      * @return The maximum Z value.
69      */
70     public double getMaxZValue();
71
72     /**
73      * Returns the array of Numbers representing the x data values.
74      *
75      * @return The array of x values.
76      */
77     public Number JavaDoc[] getXValues();
78
79     /**
80      * Returns the array of Numbers representing the y data values.
81      *
82      * @return The array of y values.
83      */
84     public Number JavaDoc[] getYValues();
85
86     /**
87      * Returns the array of Numbers representing the z data values.
88      *
89      * @return The array of z values.
90      */
91     public Number JavaDoc[] getZValues();
92
93     /**
94      * Returns an int array contain the index into the x values.
95      *
96      * @return The X values.
97      */
98     public int[] indexX();
99     
100     /**
101      * Returns the index of the xvalues.
102      *
103      * @return The x values.
104      */
105     public int[] getXIndices();
106
107     /**
108      * Returns the maximum z-value within visible region of plot.
109      *
110      * @param x the x-value.
111      * @param y the y-value.
112      *
113      * @return The maximum z-value.
114      */
115     public Range getZValueRange(Range x, Range y);
116
117     /**
118      * Returns true if axis are dates.
119      *
120      * @param axisNumber the axis where 0-x, 1-y, and 2-z.
121      *
122      * @return <code>true</code> or <code>false</code>.
123      */
124     public boolean isDateAxis(int axisNumber);
125
126 }
127
Popular Tags