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:  * $Id: YIntervalSeries.java,v 1.1.2.3 2007/02/20 16:22:01 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 20-Oct-2006 : Version 1 (DG);
  40:  * 20-Feb-2007 : Added getYHighValue() and getYLowValue() methods (DG);
  41:  *
  42:  */
  43: 
  44: package org.jfree.data.xy;
  45: 
  46: import org.jfree.data.ComparableObjectItem;
  47: import org.jfree.data.ComparableObjectSeries;
  48: 
  49: /**
  50:  * A list of (x, y, y-low, y-high) data items.
  51:  *
  52:  * @since 1.0.3
  53:  *
  54:  * @see YIntervalSeriesCollection
  55:  */
  56: public class YIntervalSeries extends ComparableObjectSeries {
  57:     
  58:     /**
  59:      * Creates a new empty series.  By default, items added to the series will 
  60:      * be sorted into ascending order by x-value, and duplicate x-values will 
  61:      * be allowed (these defaults can be modified with another constructor.
  62:      *
  63:      * @param key  the series key (<code>null</code> not permitted).
  64:      */
  65:     public YIntervalSeries(Comparable key) {
  66:         this(key, true, true);
  67:     }
  68:     
  69:     /**
  70:      * Constructs a new xy-series that contains no data.  You can specify 
  71:      * whether or not duplicate x-values are allowed for the series.
  72:      *
  73:      * @param key  the series key (<code>null</code> not permitted).
  74:      * @param autoSort  a flag that controls whether or not the items in the 
  75:      *                  series are sorted.
  76:      * @param allowDuplicateXValues  a flag that controls whether duplicate 
  77:      *                               x-values are allowed.
  78:      */
  79:     public YIntervalSeries(Comparable key, boolean autoSort, 
  80:             boolean allowDuplicateXValues) {
  81:         super(key, autoSort, allowDuplicateXValues);
  82:     }
  83:     
  84:     /**
  85:      * Adds a data item to the series.
  86:      *
  87:      * @param x  the x-value.
  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 y, double yLow, double yHigh) {
  93:         super.add(new YIntervalDataItem(x, y, yLow, yHigh), true);
  94:     }
  95:     
  96:     /**
  97:      * Returns the x-value for the specified item.
  98:      *
  99:      * @param index  the item index.
 100:      *
 101:      * @return The x-value (never <code>null</code>).
 102:      */
 103:     public Number getX(int index) {
 104:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 105:         return item.getX();
 106:     }
 107:     
 108:     /**
 109:      * Returns the y-value for the specified item.
 110:      *
 111:      * @param index  the item index.
 112:      *
 113:      * @return The y-value.
 114:      */
 115:     public double getYValue(int index) {
 116:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 117:         return item.getYValue();
 118:     }
 119:     
 120:     /**
 121:      * Returns the lower bound of the Y-interval for the specified item in the
 122:      * series.
 123:      * 
 124:      * @param index  the item index.
 125:      * 
 126:      * @return The lower bound of the Y-interval.
 127:      * 
 128:      * @since 1.0.5
 129:      */
 130:     public double getYLowValue(int index) {
 131:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 132:         return item.getYLowValue();
 133:     }
 134:     
 135:     /**
 136:      * Returns the upper bound of the y-interval for the specified item in the
 137:      * series.
 138:      * 
 139:      * @param index  the item index.
 140:      * 
 141:      * @return The upper bound of the y-interval.
 142:      * 
 143:      * @since 1.0.5
 144:      */
 145:     public double getYHighValue(int index) {
 146:         YIntervalDataItem item = (YIntervalDataItem) getDataItem(index);
 147:         return item.getYHighValue();
 148:     }
 149: 
 150:     /**
 151:      * Returns the data item at the specified index.
 152:      * 
 153:      * @param index  the item index.
 154:      * 
 155:      * @return The data item.
 156:      */
 157:     public ComparableObjectItem getDataItem(int index) {
 158:         return super.getDataItem(index);
 159:     }
 160: 
 161: }