KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > gantt > GanttCategoryDataset


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 License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -------------------------
27  * GanttCategoryDataset.java
28  * -------------------------
29  * (C) Copyright 2003-2005, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): -;
33  *
34  * $Id: GanttCategoryDataset.java,v 1.2 2005/03/23 13:48:54 mungady Exp $
35  *
36  * Changes
37  * -------
38  * 16-Sep-2003 : Version 1, based on MultiIntervalCategoryDataset (DG);
39  * 23-Sep-2003 : Fixed Checkstyle issues (DG);
40  *
41  */
42
43  package org.jfree.data.gantt;
44
45 import org.jfree.data.category.IntervalCategoryDataset;
46
47 /**
48  * An extension of the {@link IntervalCategoryDataset} interface that adds
49  * support for multiple sub-intervals.
50  */
51 public interface GanttCategoryDataset extends IntervalCategoryDataset {
52
53     /**
54      * Returns the percent complete for a given item.
55      *
56      * @param row the row index (zero-based).
57      * @param column the column index (zero-based).
58      *
59      * @return The percent complete.
60      */
61     public Number JavaDoc getPercentComplete(int row, int column);
62
63     /**
64      * Returns the percent complete for a given item.
65      *
66      * @param rowKey the row key.
67      * @param columnKey the column key.
68      *
69      * @return The percent complete.
70      */
71     public Number JavaDoc getPercentComplete(Comparable JavaDoc rowKey, Comparable JavaDoc columnKey);
72
73     /**
74      * Returns the number of sub-intervals for a given item.
75      *
76      * @param row the row index (zero-based).
77      * @param column the column index (zero-based).
78      *
79      * @return The sub-interval count.
80      */
81     public int getSubIntervalCount(int row, int column);
82
83     /**
84      * Returns the number of sub-intervals for a given item.
85      *
86      * @param rowKey the row key.
87      * @param columnKey the column key.
88      *
89      * @return The sub-interval count.
90      */
91     public int getSubIntervalCount(Comparable JavaDoc rowKey, Comparable JavaDoc columnKey);
92
93     /**
94      * Returns the start value of a sub-interval for a given item.
95      *
96      * @param row the row index (zero-based).
97      * @param column the column index (zero-based).
98      * @param subinterval the sub-interval index (zero-based).
99      *
100      * @return The start value (possibly <code>null</code>).
101      */
102     public Number JavaDoc getStartValue(int row, int column, int subinterval);
103
104     /**
105      * Returns the start value of a sub-interval for a given item.
106      *
107      * @param rowKey the row key.
108      * @param columnKey the column key.
109      * @param subinterval the sub-interval.
110      *
111      * @return The start value (possibly <code>null</code>).
112      */
113     public Number JavaDoc getStartValue(Comparable JavaDoc rowKey, Comparable JavaDoc columnKey,
114                                 int subinterval);
115
116     /**
117      * Returns the end value of a sub-interval for a given item.
118      *
119      * @param row the row index (zero-based).
120      * @param column the column index (zero-based).
121      * @param subinterval the sub-interval.
122      *
123      * @return The end value (possibly <code>null</code>).
124      */
125     public Number JavaDoc getEndValue(int row, int column, int subinterval);
126
127     /**
128      * Returns the end value of a sub-interval for a given item.
129      *
130      * @param rowKey the row key.
131      * @param columnKey the column key.
132      * @param subinterval the sub-interval.
133      *
134      * @return The end value (possibly <code>null</code>).
135      */
136     public Number JavaDoc getEndValue(Comparable JavaDoc rowKey, Comparable JavaDoc columnKey,
137                               int subinterval);
138
139     /**
140      * Returns the percentage complete value of a sub-interval for a given item.
141      *
142      * @param row the row index (zero-based).
143      * @param column the column index (zero-based).
144      * @param subinterval the sub-interval.
145      *
146      * @return The percent complete value (possibly <code>null</code>).
147      */
148     public Number JavaDoc getPercentComplete(int row, int column, int subinterval);
149
150     /**
151      * Returns the percentage complete value of a sub-interval for a given item.
152      *
153      * @param rowKey the row key.
154      * @param columnKey the column key.
155      * @param subinterval the sub-interval.
156      *
157      * @return The precent complete value (possibly <code>null</code>).
158      */
159     public Number JavaDoc getPercentComplete(Comparable JavaDoc rowKey, Comparable JavaDoc columnKey,
160                                      int subinterval);
161
162 }
163
Popular Tags