Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, 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: * XYIntervalSeries.java 29: * --------------------- 30: * (C) Copyright 2006, 2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 20-Oct-2006 : Version 1 (DG); 38: * 13-Feb-2007 : Added several new accessor methods (DG); 39: * 40: */ 41: 42: package org.jfree.data.xy; 43: 44: import org.jfree.data.ComparableObjectItem; 45: import org.jfree.data.ComparableObjectSeries; 46: 47: /** 48: * A list of (x, x-low, x-high, y, y-low, y-high) data items. 49: * 50: * @since 1.0.3 51: * 52: * @see XYIntervalSeriesCollection 53: */ 54: public class XYIntervalSeries extends ComparableObjectSeries { 55: 56: /** 57: * Creates a new empty series. By default, items added to the series will 58: * be sorted into ascending order by x-value, and duplicate x-values will 59: * be allowed (these defaults can be modified with another constructor). 60: * 61: * @param key the series key (<code>null</code> not permitted). 62: */ 63: public XYIntervalSeries(Comparable key) { 64: this(key, true, true); 65: } 66: 67: /** 68: * Constructs a new xy-series that contains no data. You can specify 69: * whether or not duplicate x-values are allowed for the series. 70: * 71: * @param key the series key (<code>null</code> not permitted). 72: * @param autoSort a flag that controls whether or not the items in the 73: * series are sorted. 74: * @param allowDuplicateXValues a flag that controls whether duplicate 75: * x-values are allowed. 76: */ 77: public XYIntervalSeries(Comparable key, boolean autoSort, 78: boolean allowDuplicateXValues) { 79: super(key, autoSort, allowDuplicateXValues); 80: } 81: 82: /** 83: * Adds a data item to the series. 84: * 85: * @param x the x-value. 86: * @param xLow the lower bound of the x-interval. 87: * @param xHigh the upper bound of the x-interval. 88: * @param y the y-value. 89: * @param yLow the lower bound of the y-interval. 90: * @param yHigh the upper bound of the y-interval. 91: */ 92: public void add(double x, double xLow, double xHigh, double y, double yLow, 93: double yHigh) { 94: super.add(new XYIntervalDataItem(x, xLow, xHigh, y, yLow, yHigh), true); 95: } 96: 97: /** 98: * Returns the x-value for the specified item. 99: * 100: * @param index the item index. 101: * 102: * @return The x-value (never <code>null</code>). 103: */ 104: public Number getX(int index) { 105: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 106: return item.getX(); 107: } 108: 109: /** 110: * Returns the lower bound of the x-interval for the specified item in the 111: * series. 112: * 113: * @param index the item index. 114: * 115: * @return The lower bound of the x-interval. 116: * 117: * @since 1.0.5 118: */ 119: public double getXLowValue(int index) { 120: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 121: return item.getXLowValue(); 122: } 123: 124: /** 125: * Returns the upper bound of the x-interval for the specified item in the 126: * series. 127: * 128: * @param index the item index. 129: * 130: * @return The upper bound of the x-interval. 131: * 132: * @since 1.0.5 133: */ 134: public double getXHighValue(int index) { 135: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 136: return item.getXHighValue(); 137: } 138: 139: /** 140: * Returns the y-value for the specified item. 141: * 142: * @param index the item index. 143: * 144: * @return The y-value. 145: */ 146: public double getYValue(int index) { 147: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 148: return item.getYValue(); 149: } 150: 151: /** 152: * Returns the lower bound of the Y-interval for the specified item in the 153: * series. 154: * 155: * @param index the item index. 156: * 157: * @return The lower bound of the Y-interval. 158: * 159: * @since 1.0.5 160: */ 161: public double getYLowValue(int index) { 162: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 163: return item.getYLowValue(); 164: } 165: 166: /** 167: * Returns the upper bound of the y-interval for the specified item in the 168: * series. 169: * 170: * @param index the item index. 171: * 172: * @return The upper bound of the y-interval. 173: * 174: * @since 1.0.5 175: */ 176: public double getYHighValue(int index) { 177: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index); 178: return item.getYHighValue(); 179: } 180: 181: /** 182: * Returns the data item at the specified index. 183: * 184: * @param index the item index. 185: * 186: * @return The data item. 187: */ 188: public ComparableObjectItem getDataItem(int index) { 189: return super.getDataItem(index); 190: } 191: 192: }