KickJava   Java API By Example, From Geeks To Geeks.

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


1 /***********************************************************************************************
2  * File Info: $Id: IAxisDataSeries.java,v 1.2 2003/08/28 00:56:34 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.chartData.ChartDataException;
44 import org.krysalis.jcharts.properties.PropertyException;
45 import org.krysalis.jcharts.types.ChartType;
46
47 import java.util.Iterator JavaDoc;
48
49
50 public interface IAxisDataSeries extends IData
51 {
52
53     /******************************************************************************************
54      * Returns the x-axis title.
55      *
56      * @return String the x-axis title. If this returns NULL, no title will be displayed.
57      ******************************************************************************************/

58     public String JavaDoc getXAxisTitle();
59
60
61     /******************************************************************************************
62      * Returns the y-axis title.
63      *
64      * @return String the y-axis title. If this returns NULL, no title will be displayed.
65      ******************************************************************************************/

66     public String JavaDoc getYAxisTitle();
67
68
69     /******************************************************************************************
70      * Returns the chart title.
71      *
72      * @return String the chart title. If this returns NULL, no title will be displayed.
73      ******************************************************************************************/

74     public String JavaDoc getChartTitle();
75
76
77     /*********************************************************************************************
78      * Validates the DataSeries implementation. This will only get called if the ChartProperties
79      * flag to validate is true.
80      *
81      * @throws ChartDataException
82      * @throws PropertyException
83      * @since 0.7.0
84      * @see org.krysalis.jcharts.properties.ChartProperties#setValidate( boolean )
85      *********************************************************************************************/

86     public void validate() throws ChartDataException, PropertyException;
87
88
89     public Iterator JavaDoc getIAxisPlotDataSetIterator();
90
91
92     public void addIAxisPlotDataSet( IAxisPlotDataSet iAxisPlotDataSet );
93
94
95     public IAxisPlotDataSet getIAxisPlotDataSet( ChartType chartType );
96
97
98     /******************************************************************************************
99      * Returns the total number data dimensions in all of the IAxisChartDataSets contained in
100      * this collection. For example, if this contains two IAxisChartDataSets and each one
101      * contains 3 dimensions ( 3 lines and 3 sets of points ), this should return six. This
102      * provides a means to avoid looping the contents of the series each time i need the value.
103      *
104      * @return int
105      ******************************************************************************************/

106     public int getTotalNumberOfDataSets();
107
108
109     /******************************************************************************************
110      * Returns the number of IAxisPlotDataSet Objects in this series
111      *
112      * @return int
113      ******************************************************************************************/

114     int size();
115
116 }
117
Popular Tags