IntervalCategoryDataset


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   * IntervalCategoryDataset.java
24   * ----------------------------
25   * (C) Copyright 2002, 2003, by Eduard Martinescu and Contributors.
26   *
27   * Original Author:  Eduard Martinescu;
28   * Contributor(s):   David Gilbert (for Object Refinery Limited);
29   *
30   * $Id: IntervalCategoryDataset.java,v 1.3 2003/11/28 11:37:28 mungady Exp $
31   *
32   * Changes
33   * -------
34   * 19-Mar-2002 : Version 1 contributed by Eduard Martinescu.  The interface name and method names
35   *               have been renamed to be consistent with existing interfaces (DG);
36   * 06-Jun-2002 : Updated Javadoc comments (DG);
37   * 24-Oct-2002 : Categories and series are now indexed by int or Comparable, following changes
38   *               made to the CategoryDataset interface (DG);
39   *
40   */
41  
42  package org.jfree.data;
43  
44  /**
45   * A category dataset that defines a value range for each series/category combination.
46   *
47   * @author Eduard Martinescu
48   */
49  public interface IntervalCategoryDataset extends CategoryDataset {
50  
51      /**
52       * Returns the start value for the interval for a given series and category.
53       *
54       * @param series  the series (zero-based index).
55       * @param category  the category (zero-based index).
56       *
57       * @return the start value (possibly <code>null</code>).
58       */
59      public Number   getStartValue(int series, int category);
60  
61      /**
62       * Returns the start value for the interval for a given series and category.
63       *
64       * @param series  the series key.
65       * @param category  the category key.
66       *
67       * @return the start value (possibly <code>null</code>).
68       */
69      public Number   getStartValue(Comparable   series, Comparable   category);
70  
71      /**
72       * Returns the end value for the interval for a given series and category.
73       *
74       * @param series  the series (zero-based index).
75       * @param category  the category (zero-based index).
76       *
77       * @return the end value (possibly <code>null</code>).
78       */
79      public Number   getEndValue(int series, int category);
80  
81      /**
82       * Returns the end value for the interval for a given series and category.
83       *
84       * @param series  the series key.
85       * @param category  the category key.
86       *
87       * @return the end value (possibly <code>null</code>).
88       */
89      public Number   getEndValue(Comparable   series, Comparable   category);
90  
91  }
92
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags