Source for org.jfree.data.time.ohlc.OHLCSeries

   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:  * OHLCSeries.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:  * 04-Dec-2006 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.data.time.ohlc;
  42: 
  43: import org.jfree.data.ComparableObjectItem;
  44: import org.jfree.data.ComparableObjectSeries;
  45: import org.jfree.data.time.RegularTimePeriod;
  46: 
  47: /**
  48:  * A list of (RegularTimePeriod, open, high, low, close) data items.
  49:  *
  50:  * @since 1.0.4
  51:  *
  52:  * @see OHLCSeriesCollection
  53:  */
  54: public class OHLCSeries 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 period, and duplicate periods will 
  59:      * not be allowed.
  60:      *
  61:      * @param key  the series key (<code>null</code> not permitted).
  62:      */
  63:     public OHLCSeries(Comparable key) {
  64:         super(key, true, false);
  65:     }
  66:     
  67:     /**
  68:      * Returns the time period for the specified item.
  69:      * 
  70:      * @param index  the item index.
  71:      * 
  72:      * @return The time period.
  73:      */
  74:     public RegularTimePeriod getPeriod(int index) {
  75:         final OHLCItem item = (OHLCItem) getDataItem(index);
  76:         return item.getPeriod();
  77:     }
  78:     
  79:     /**
  80:      * Returns the data item at the specified index.
  81:      * 
  82:      * @param index  the item index.
  83:      * 
  84:      * @return The data item.
  85:      */
  86:     public ComparableObjectItem getDataItem(int index) {
  87:         return super.getDataItem(index);
  88:     }
  89: 
  90:     /**
  91:      * Adds a data item to the series.
  92:      *
  93:      * @param period  the period.
  94:      * @param open  the open-value.
  95:      * @param high  the high-value.
  96:      * @param low  the low-value.
  97:      * @param close  the close-value.
  98:      */
  99:     public void add(RegularTimePeriod period, double open, double high, 
 100:             double low, double close) {
 101:         if (getItemCount() > 0) {
 102:             OHLCItem item0 = (OHLCItem) this.getDataItem(0);
 103:             if (!period.getClass().equals(item0.getPeriod().getClass())) {
 104:                 throw new IllegalArgumentException(
 105:                         "Can't mix RegularTimePeriod class types.");
 106:             }
 107:         }
 108:         super.add(new OHLCItem(period, open, high, low, close), true);
 109:     }
 110: 
 111: }