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