BoxAndWhiskerCategoryDataset


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   * BoxAndWhiskerCategoryDataset.java
28   * ---------------------------------
29   * (C) Copyright 2003, by David Browning and Contributors.
30   *
31   * Original Author:  David Browning (for Australian Institute of Marine 
32   *                   Science);
33   * Contributor(s):   -;
34   *
35   * $Id: BoxAndWhiskerCategoryDataset.java,v 1.3 2005/03/28 19:44:07 mungady Exp $
36   *
37   * Changes
38   * -------
39   * 05-Aug-2003 : Version 1, contributed by David Browning (DG);
40   * 27-Aug-2003 : Renamed getAverageValue --> getMeanValue, changed 
41   *               getAllOutliers to return a List rather than an array (DG);
42   *
43   */
44  
45  package org.jfree.data.statistics;
46  
47  import java.util.List  ;
48  
49  import org.jfree.data.category.CategoryDataset;
50  
51  /**
52   * A category dataset that defines various medians, outliers and an average 
53   * value for each item.
54   *
55   * @author David Browning
56   */
57  public interface BoxAndWhiskerCategoryDataset extends CategoryDataset {
58  
59      /**
60       * Returns the mean value for an item.
61       *
62       * @param row  the row index (zero-based).
63       * @param column  the column index (zero-based).
64       *
65       * @return The mean value.
66       */
67      public Number   getMeanValue(int row, int column);
68  
69      /**
70       * Returns the average value for an item.
71       *
72       * @param rowKey  the row key.
73       * @param columnKey  the columnKey.
74       *
75       * @return The average value.
76       */
77      public Number   getMeanValue(Comparable   rowKey, Comparable   columnKey);
78  
79      /**
80       * Returns the median value for an item.
81       *
82       * @param row  the row index (zero-based).
83       * @param column  the column index (zero-based).
84       *
85       * @return The median value.
86       */
87      public Number   getMedianValue(int row, int column);
88  
89      /**
90       * Returns the median value for an item.
91       *
92       * @param rowKey  the row key.
93       * @param columnKey  the columnKey.
94       *
95       * @return The median value.
96       */
97      public Number   getMedianValue(Comparable   rowKey, Comparable   columnKey);
98  
99      /**
100      * Returns the q1median value for an item.
101      *
102      * @param row  the row index (zero-based).
103      * @param column  the column index (zero-based).
104      *
105      * @return The q1median value.
106      */
107     public Number   getQ1Value(int row, int column);
108 
109     /**
110      * Returns the q1median value for an item.
111      *
112      * @param rowKey  the row key.
113      * @param columnKey  the columnKey.
114      *
115      * @return The q1median value.
116      */
117     public Number   getQ1Value(Comparable   rowKey, Comparable   columnKey);
118 
119     /**
120      * Returns the q3median value for an item.
121      *
122      * @param row  the row index (zero-based).
123      * @param column  the column index (zero-based).
124      *
125      * @return The q3median value.
126      */
127     public Number   getQ3Value(int row, int column);
128 
129     /**
130      * Returns the q3median value for an item.
131      *
132      * @param rowKey  the row key.
133      * @param columnKey  the columnKey.
134      *
135      * @return The q3median value.
136      */
137     public Number   getQ3Value(Comparable   rowKey, Comparable   columnKey);
138 
139     /**
140      * Returns the minimum regular (non-outlier) value for an item.
141      *
142      * @param row  the row index (zero-based).
143      * @param column  the column index (zero-based).
144      *
145      * @return The minimum regular value.
146      */
147     public Number   getMinRegularValue(int row, int column);
148 
149     /**
150      * Returns the minimum regular (non-outlier) value for an item.
151      *
152      * @param rowKey  the row key.
153      * @param columnKey  the columnKey.
154      *
155      * @return The minimum regular value.
156      */
157     public Number   getMinRegularValue(Comparable   rowKey, Comparable   columnKey);
158 
159     /**
160      * Returns the maximum regular (non-outlier) value for an item.
161      *
162      * @param row  the row index (zero-based).
163      * @param column  the column index (zero-based).
164      *
165      * @return The maximum regular value.
166      */
167     public Number   getMaxRegularValue(int row, int column);
168 
169     /**
170      * Returns the maximum regular (non-outlier) value for an item.
171      *
172      * @param rowKey  the row key.
173      * @param columnKey  the columnKey.
174      *
175      * @return The maximum regular value.
176      */
177     public Number   getMaxRegularValue(Comparable   rowKey, Comparable   columnKey);
178 
179     /**
180      * Returns the minimum outlier (non-farout) for an item.
181      *
182      * @param row  the row index (zero-based).
183      * @param column  the column index (zero-based).
184      *
185      * @return The minimum outlier.
186      */
187     public Number   getMinOutlier(int row, int column);
188 
189     /**
190      * Returns the minimum outlier (non-farout) for an item.
191      *
192      * @param rowKey  the row key.
193      * @param columnKey  the columnKey.
194      *
195      * @return The minimum outlier.
196      */
197     public Number   getMinOutlier(Comparable   rowKey, Comparable   columnKey);
198 
199     /**
200      * Returns the maximum outlier (non-farout) for an item.
201      *
202      * @param row  the row index (zero-based).
203      * @param column  the column index (zero-based).
204      *
205      * @return The maximum outlier.
206      */
207     public Number   getMaxOutlier(int row, int column);
208 
209     /**
210      * Returns the maximum outlier (non-farout) for an item.
211      *
212      * @param rowKey  the row key.
213      * @param columnKey  the columnKey.
214      *
215      * @return The maximum outlier.
216      */
217     public Number   getMaxOutlier(Comparable   rowKey, Comparable   columnKey);
218 
219     /**
220      * Returns a list of outlier values for an item.  The list may be empty, 
221      * but should never be <code>null</code>.
222      *
223      * @param row  the row index (zero-based).
224      * @param column  the column index (zero-based).
225      *
226      * @return A list of outliers for an item.
227      */
228     public List   getOutliers(int row, int column);
229 
230     /**
231      * Returns a list of outlier values for an item.  The list may be empty, 
232      * but should never be <code>null</code>.
233      *
234      * @param rowKey  the row key.
235      * @param columnKey  the columnKey.
236      *
237      * @return A list of outlier values for an item.
238      */
239     public List   getOutliers(Comparable   rowKey, Comparable   columnKey);
240 
241 }
242
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags