Source for org.jfree.data.xy.YIntervalSeries

   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:  * YIntervalSeries.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:  * 20-Feb-2007 : Added getYHighValue() and getYLowValue() 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, y, y-low, y-high) data items.
  49:  *
  50:  * @since 1.0.3
  51:  *
  52:  * @see YIntervalSeriesCollection
  53:  */
  54: public class YIntervalSeries 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 YIntervalSeries(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 YIntervalSeries(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 y  the y-value.
  87:      * @param yLow  the lower bound of the y-interval.
  88:      * @param yHigh  the upper bound of the y-interval.
  89:      */
  90:     public void add(double x, double y, double yLow, double yHigh) {
  91:         super.add(new YIntervalDataItem(x, y, yLow, yHigh), true);
  92:     }
  93:     
  94:     /**
  95:      * Returns the x-value for the specified item.
  96:      *
  97:      * @param index  the item index.
  98:      *
  99:      * @return The x-value (never <code>null</code>).
 100:      */
 101:     public Number getX(int index) {
 102:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 103:         return item.getX();
 104:     }
 105:     
 106:     /**
 107:      * Returns the y-value for the specified item.
 108:      *
 109:      * @param index  the item index.
 110:      *
 111:      * @return The y-value.
 112:      */
 113:     public double getYValue(int index) {
 114:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 115:         return item.getYValue();
 116:     }
 117:     
 118:     /**
 119:      * Returns the lower bound of the Y-interval for the specified item in the
 120:      * series.
 121:      * 
 122:      * @param index  the item index.
 123:      * 
 124:      * @return The lower bound of the Y-interval.
 125:      * 
 126:      * @since 1.0.5
 127:      */
 128:     public double getYLowValue(int index) {
 129:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 130:         return item.getYLowValue();
 131:     }
 132:     
 133:     /**
 134:      * Returns the upper bound of the y-interval for the specified item in the
 135:      * series.
 136:      * 
 137:      * @param index  the item index.
 138:      * 
 139:      * @return The upper bound of the y-interval.
 140:      * 
 141:      * @since 1.0.5
 142:      */
 143:     public double getYHighValue(int index) {
 144:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 145:         return item.getYHighValue();
 146:     }
 147: 
 148:     /**
 149:      * Returns the data item at the specified index.
 150:      * 
 151:      * @param index  the item index.
 152:      * 
 153:      * @return The data item.
 154:      */
 155:     public ComparableObjectItem getDataItem(int index) {
 156:         return super.getDataItem(index);
 157:     }
 158: 
 159: }