KickJava   Java API By Example, From Geeks To Geeks.

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


1 /* ======================================
2  * JFreeChart : a free Java chart library
3  * ======================================
4  *
5  * Project Info: http://www.jfree.org/jfreechart/index.html
6  * Project Lead: David Gilbert (david.gilbert@object-refinery.com);
7  *
8  * (C) Copyright 2000-2003, by Object Refinery Limited and Contributors.
9  *
10  * This library is free software; you can redistribute it and/or modify it under the terms
11  * of the GNU Lesser General Public License as published by the Free Software Foundation;
12  * either version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License along with this
19  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20  * Boston, MA 02111-1307, USA.
21  *
22  * -------------------
23  * HighLowDataset.java
24  * -------------------
25  * (C) Copyright 2001-2003, by Object Refinery Limited.
26  *
27  * Original Author: David Gilbert (for Object Refinery Limited);
28  * Contributor(s): Sylvain Vieujot;
29  *
30  * $Id: HighLowDataset.java,v 1.2 2003/06/04 22:58:27 mungady Exp $
31  *
32  * Changes (from 18-Sep-2001)
33  * --------------------------
34  * 18-Sep-2001 : Updated header info (DG);
35  * 16-Oct-2001 : Moved to package com.jrefinery.data.* (DG);
36  * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc. (DG);
37  * 05-Feb-2002 : Added getVolumeValue() method, as requested by Sylvain Vieujot (DG);
38  *
39  */
40
41 package org.jfree.data;
42
43 /**
44  * An interface that defines data in the form of (x, high, low, open, close) tuples.
45  * <P>
46  * Example: JFreeChart used this interface to obtain data for high-low-open-close plots.
47  *
48  * @author David Gilbert
49  *
50  */
51 public interface HighLowDataset extends XYDataset {
52
53     /**
54      * Returns the high-value for the specified series and item.
55      *
56      * @param series the series (zero-based index).
57      * @param item the item (zero-based index).
58      *
59      * @return the high-value for the specified series and item.
60      */
61     public Number JavaDoc getHighValue(int series, int item);
62
63     /**
64      * Returns the low-value for the specified series and item.
65      *
66      * @param series the series (zero-based index).
67      * @param item the item (zero-based index).
68      *
69      * @return the low-value for the specified series and item.
70      */
71     public Number JavaDoc getLowValue(int series, int item);
72
73     /**
74      * Returns the open-value for the specified series and item.
75      *
76      * @param series the series (zero-based index).
77      * @param item the item (zero-based index).
78      *
79      * @return the open-value for the specified series and item.
80      */
81     public Number JavaDoc getOpenValue(int series, int item);
82
83     /**
84      * Returns the y-value for the specified series and item.
85      *
86      * @param series the series (zero-based index).
87      * @param item the item (zero-based index).
88      *
89      * @return the y-value for the specified series and item.
90      */
91     public Number JavaDoc getCloseValue(int series, int item);
92
93     /**
94      * Returns the volume for the specified series and item.
95      *
96      * @param series the series (zero-based index).
97      * @param item the item (zero-based index).
98      *
99      * @return the volume for the specified series and item.
100      */
101     public Number JavaDoc getVolumeValue(int series, int item);
102
103 }
104
Popular Tags