KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > xy > WindDataset


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2006, 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  * WindDataset.java
29  * ----------------
30  * (C) Copyright 2001-2006, by Achilleus Mantzios and Contributors.
31  *
32  * Original Author: Achilleus Mantzios;
33  * Contributor(s): David Gilbert (for Object Refinery Limited);
34  *
35  * $Id: WindDataset.java,v 1.2.2.2 2006/07/12 13:50:48 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 06-Feb-2002 : Version 1, based on code contributed by Achilleus
40  * Mantzios (DG);
41  *
42  */
43
44 package org.jfree.data.xy;
45
46 /**
47  * Interface for a dataset that supplies wind intensity and direction values
48  * observed at various points in time.
49  */
50 public interface WindDataset extends XYDataset {
51
52     /**
53      * Returns the wind direction (should be in the range 0 to 12,
54      * corresponding to the positions on an upside-down clock face).
55      *
56      * @param series the series (in the range <code>0</code> to
57      * <code>getSeriesCount() - 1</code>).
58      * @param item the item (in the range <code>0</code> to
59      * <code>getItemCount(series) - 1</code>).
60      *
61      * @return The wind direction.
62      */
63     public Number JavaDoc getWindDirection(int series, int item);
64
65     /**
66      * Returns the wind force on the Beaufort scale (0 to 12). See:
67      * <p>
68      * http://en.wikipedia.org/wiki/Beaufort_scale
69      *
70      * @param series the series (in the range <code>0</code> to
71      * <code>getSeriesCount() - 1</code>).
72      * @param item the item (in the range <code>0</code> to
73      * <code>getItemCount(series) - 1</code>).
74      *
75      * @return The wind force.
76      */
77     public Number JavaDoc getWindForce(int series, int item);
78
79 }
80
Popular Tags