Source for org.jfree.data.xy.XIntervalSeries

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2006, 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:  * XIntervalSeries.java
  29:  * --------------------
  30:  * (C) Copyright 2006, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: XIntervalSeries.java,v 1.1.2.3 2006/10/23 09:19:50 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 20-Oct-2006 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.data.xy;
  44: 
  45: import org.jfree.data.ComparableObjectItem;
  46: import org.jfree.data.ComparableObjectSeries;
  47: 
  48: /**
  49:  * A list of (x, x-low, x-high, y) data items.
  50:  *
  51:  * @since 1.0.3
  52:  *
  53:  * @see XIntervalSeriesCollection
  54:  */
  55: public class XIntervalSeries extends ComparableObjectSeries {
  56:     
  57:     /**
  58:      * Creates a new empty series.  By default, items added to the series will 
  59:      * be sorted into ascending order by x-value, and duplicate x-values will 
  60:      * be allowed (these defaults can be modified with another constructor.
  61:      *
  62:      * @param key  the series key (<code>null</code> not permitted).
  63:      */
  64:     public XIntervalSeries(Comparable key) {
  65:         this(key, true, true);
  66:     }
  67:     
  68:     /**
  69:      * Constructs a new xy-series that contains no data.  You can specify 
  70:      * whether or not duplicate x-values are allowed for the series.
  71:      *
  72:      * @param key  the series key (<code>null</code> not permitted).
  73:      * @param autoSort  a flag that controls whether or not the items in the 
  74:      *                  series are sorted.
  75:      * @param allowDuplicateXValues  a flag that controls whether duplicate 
  76:      *                               x-values are allowed.
  77:      */
  78:     public XIntervalSeries(Comparable key, boolean autoSort, 
  79:             boolean allowDuplicateXValues) {
  80:         super(key, autoSort, allowDuplicateXValues);
  81:     }
  82:     
  83:     /**
  84:      * Adds a data item to the series.
  85:      *
  86:      * @param x  the x-value.
  87:      * @param y  the y-value.
  88:      * @param xLow  the lower bound of the y-interval.
  89:      * @param xHigh  the upper bound of the y-interval.
  90:      */
  91:     public void add(double x, double xLow, double xHigh, double y) {
  92:         super.add(new XIntervalDataItem(x, xLow, xHigh, y), true);
  93:     }
  94:     
  95:     /**
  96:      * Returns the x-value for the specified item.
  97:      *
  98:      * @param index  the item index.
  99:      *
 100:      * @return The x-value (never <code>null</code>).
 101:      */
 102:     public Number getX(int index) {
 103:         XIntervalDataItem item = (XIntervalDataItem) getDataItem(index);
 104:         return item.getX();
 105:     }
 106:     
 107:     /**
 108:      * Returns the y-value for the specified item.
 109:      *
 110:      * @param index  the item index.
 111:      *
 112:      * @return The y-value.
 113:      */
 114:     public double getYValue(int index) {
 115:         XIntervalDataItem item = (XIntervalDataItem) getDataItem(index);
 116:         return item.getYValue();
 117:     }
 118:     
 119:     /**
 120:      * Returns the data item at the specified index.
 121:      * 
 122:      * @param index  the item index.
 123:      * 
 124:      * @return The data item.
 125:      */
 126:     public ComparableObjectItem getDataItem(int index) {
 127:         return super.getDataItem(index);
 128:     }
 129:     
 130: }