Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2008, 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 20: * License along with this library; if not, write to the Free Software 21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 22: * USA. 23: * 24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 25: * in the United States and other countries.] 26: * 27: * ---------------------------- 28: * IntervalCategoryDataset.java 29: * ---------------------------- 30: * (C) Copyright 2002-2008, by Eduard Martinescu and Contributors. 31: * 32: * Original Author: Eduard Martinescu; 33: * Contributor(s): David Gilbert (for Object Refinery Limited); 34: * 35: * Changes 36: * ------- 37: * 19-Mar-2002 : Version 1 contributed by Eduard Martinescu. The interface 38: * name and method names have been renamed to be consistent with 39: * existing interfaces (DG); 40: * 06-Jun-2002 : Updated Javadoc comments (DG); 41: * 24-Oct-2002 : Categories and series are now indexed by int or Comparable, 42: * following changes made to the CategoryDataset interface (DG); 43: * 12-May-2008 : Updated API docs (DG); 44: * 45: */ 46: 47: package org.jfree.data.category; 48: 49: 50: /** 51: * A category dataset that defines a value range for each series/category 52: * combination. 53: */ 54: public interface IntervalCategoryDataset extends CategoryDataset { 55: 56: /** 57: * Returns the start value for the interval for a given series and category. 58: * 59: * @param series the series (zero-based index). 60: * @param category the category (zero-based index). 61: * 62: * @return The start value (possibly <code>null</code>). 63: * 64: * @see #getEndValue(int, int) 65: */ 66: public Number getStartValue(int series, int category); 67: 68: /** 69: * Returns the start value for the interval for a given series and category. 70: * 71: * @param series the series key. 72: * @param category the category key. 73: * 74: * @return The start value (possibly <code>null</code>). 75: * 76: * @see #getEndValue(Comparable, Comparable) 77: */ 78: public Number getStartValue(Comparable series, Comparable category); 79: 80: /** 81: * Returns the end value for the interval for a given series and category. 82: * 83: * @param series the series (zero-based index). 84: * @param category the category (zero-based index). 85: * 86: * @return The end value (possibly <code>null</code>). 87: * 88: * @see #getStartValue(int, int) 89: */ 90: public Number getEndValue(int series, int category); 91: 92: /** 93: * Returns the end value for the interval for a given series and category. 94: * 95: * @param series the series key. 96: * @param category the category key. 97: * 98: * @return The end value (possibly <code>null</code>). 99: * 100: * @see #getStartValue(Comparable, Comparable) 101: */ 102: public Number getEndValue(Comparable series, Comparable category); 103: 104: }