KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > krysalis > jcharts > chartData > interfaces > IDataSet


1 /***********************************************************************************************
2  * File Info: $Id: IDataSet.java,v 1.1 2003/05/17 16:57:26 nathaniel_auvil Exp $
3  * Copyright (C) 2002
4  * Author: Nathaniel G. Auvil
5  * Contributor(s):
6  *
7  * Copyright 2002 (C) Nathaniel G. Auvil. All Rights Reserved.
8  *
9  * Redistribution and use of this software and associated documentation ("Software"), with or
10  * without modification, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain copyright statements and notices.
13  * Redistributions must also contain a copy of this document.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
16  * conditions and the following disclaimer in the documentation and/or other materials
17  * provided with the distribution.
18  *
19  * 3. The name "jCharts" or "Nathaniel G. Auvil" must not be used to endorse or promote
20  * products derived from this Software without prior written permission of Nathaniel G.
21  * Auvil. For written permission, please contact nathaniel_auvil@users.sourceforge.net
22  *
23  * 4. Products derived from this Software may not be called "jCharts" nor may "jCharts" appear
24  * in their names without prior written permission of Nathaniel G. Auvil. jCharts is a
25  * registered trademark of Nathaniel G. Auvil.
26  *
27  * 5. Due credit should be given to the jCharts Project (http://jcharts.sourceforge.net/).
28  *
29  * THIS SOFTWARE IS PROVIDED BY Nathaniel G. Auvil AND CONTRIBUTORS ``AS IS'' AND ANY
30  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * jCharts OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT
36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
37  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  ************************************************************************************************/
39
40 package org.krysalis.jcharts.chartData.interfaces;
41
42
43 import org.krysalis.jcharts.properties.ChartTypeProperties;
44
45 import java.awt.*;
46
47
48 public interface IDataSet extends IData
49 {
50
51     /******************************************************************************************
52      * Returns the Paint Object for the passed index. This index corresponds to the DataSet
53      * for which Paint you want.
54      *
55      * @param index
56      * @return Paint
57      *******************************************************************************************/
58     public Paint getPaint( int index );
59
60
61     /******************************************************************************************
62      * Returns ChartTypeProperties Object for the data set which will be typed into the specific
63      * chart type class.
64      *
65      * @return ChartTypeProperties
66      *******************************************************************************************/
67     public ChartTypeProperties getChartTypeProperties();
68
69
70     /******************************************************************************************
71      * Returns the Legend Label for the passed index. This index corresponds to the DataSet
72      * for which Label you want.
73      *
74      * @param index
75      * @return String should return NULL of no labels specified
76      *******************************************************************************************/
77     public String JavaDoc getLegendLabel( int index );
78
79
80     /******************************************************************************************
81      * Returns the number of elements in the data set.
82      *
83      * @return int
84      *******************************************************************************************/
85     public int getNumberOfDataItems();
86
87
88     /******************************************************************************************
89      * Returns the number of legend labels in the data set.
90      *
91      * @return int should return 0 if no labels specified
92      *******************************************************************************************/
93     public int getNumberOfLegendLabels();
94
95
96 }
97
Popular Tags