com.caplin.charting

Class OhlcvData

java.lang.Object

com.caplin.charting.OhlcvData

public class OhlcvData
extends java.lang.Object

OhlcvData represents a datapoint on a chart with Open, High, Low, Close and Volume. A single OhlcvData object would commonly be plotted as a candlestick.

Constructor Summary

Constructors

Constructor and Description
OhlcvData(java.util.Date time, double high, double low, double open, double close, double volume)

Method Summary

Methods

Modifier and Type	Method and Description
double	getClose()
double	getHigh()
double	getLow()
double	getOpen()
java.util.Date	getTime()
double	getVolume()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OhlcvData

public OhlcvData(java.util.Date time,
         double high,
         double low,
         double open,
         double close,
         double volume)

Parameters:

time - the time of the data

high - the highest price that was reached during this time period. This must be larger than low, open and close.

low - the lowest price that was reached during this time period. This must be smaller than high, open and close.

open - the price that the instrument opened this time period with.

close - the price that the instrument closed this time period with.

volume - the volume of trading during this time period.

Throws:

java.lang.IllegalArgumentException - if high or low are not respectively the largest and smallest of the values (high, low, open, close).

java.lang.NullPointerException - if time is null.

Method Detail

getTime

public java.util.Date getTime()

Returns:

the time.

getOpen

public double getOpen()

Returns:

the open price for this period.

getHigh

public double getHigh()

Returns:

the high price for this period. Will not be smaller than open, close or low.

getClose

public double getClose()

Returns:

the close price for this period.

getLow

public double getLow()

Returns:

the low price for this period. Will not be larger than open, close or high.

getVolume

public double getVolume()

Returns:

the volume for this period.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object