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

   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:  * OHLCItem.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.time.RegularTimePeriod;
  45: 
  46: /**
  47:  * An item representing data in the form (period, open, high, low, close).
  48:  *
  49:  * @since 1.0.4
  50:  */
  51: public class OHLCItem extends ComparableObjectItem {
  52: 
  53:     /** 
  54:      * Creates a new instance of <code>OHLCItem</code>.
  55:      *
  56:      * @param period  the time period.
  57:      * @param open  the open-value.
  58:      * @param high  the high-value.
  59:      * @param low  the low-value.
  60:      * @param close  the close-value.
  61:      */
  62:     public OHLCItem(RegularTimePeriod period, double open, double high, 
  63:             double low, double close) {
  64:         super(period, new OHLC(open, high, low, close));
  65:     }
  66:     
  67:     /**
  68:      * Returns the period.
  69:      *
  70:      * @return The period (never <code>null</code>).
  71:      */
  72:     public RegularTimePeriod getPeriod() {
  73:         return (RegularTimePeriod) getComparable();
  74:     }
  75:     
  76:     /**
  77:      * Returns the y-value.
  78:      *
  79:      * @return The y-value.
  80:      */
  81:     public double getYValue() {
  82:         return getCloseValue();
  83:     }
  84:     
  85:     /**
  86:      * Returns the open value.
  87:      *
  88:      * @return The open value.
  89:      */
  90:     public double getOpenValue() {
  91:         OHLC ohlc = (OHLC) getObject();
  92:         if (ohlc != null) {
  93:             return ohlc.getOpen();
  94:         }
  95:         else {
  96:             return Double.NaN;
  97:         }
  98:     }
  99:     
 100:     /**
 101:      * Returns the high value.
 102:      *
 103:      * @return The high value.
 104:      */
 105:     public double getHighValue() {
 106:         OHLC ohlc = (OHLC) getObject();
 107:         if (ohlc != null) {
 108:             return ohlc.getHigh();
 109:         }
 110:         else {
 111:             return Double.NaN;
 112:         }
 113:     }
 114: 
 115:     /**
 116:      * Returns the low value.
 117:      *
 118:      * @return The low value.
 119:      */
 120:     public double getLowValue() {
 121:         OHLC ohlc = (OHLC) getObject();
 122:         if (ohlc != null) {
 123:             return ohlc.getLow();
 124:         }
 125:         else {
 126:             return Double.NaN;
 127:         }
 128:     }
 129: 
 130:     /**
 131:      * Returns the close value.
 132:      *
 133:      * @return The close value.
 134:      */
 135:     public double getCloseValue() {
 136:         OHLC ohlc = (OHLC) getObject();
 137:         if (ohlc != null) {
 138:             return ohlc.getClose();
 139:         }
 140:         else {
 141:             return Double.NaN;
 142:         }
 143:     }
 144:     
 145: }