org.jfree.data.time.ohlc

Class OHLCSeries

public class OHLCSeries extends ComparableObjectSeries

A list of (RegularTimePeriod, open, high, low, close) data items.

Since: 1.0.4

See Also: OHLCSeriesCollection

Constructor Summary
OHLCSeries(Comparable key)
Creates a new empty series.
Method Summary
voidadd(RegularTimePeriod period, double open, double high, double low, double close)
Adds a data item to the series.
ComparableObjectItemgetDataItem(int index)
Returns the data item at the specified index.
RegularTimePeriodgetPeriod(int index)
Returns the time period for the specified item.

Constructor Detail

OHLCSeries

public OHLCSeries(Comparable key)
Creates a new empty series. By default, items added to the series will be sorted into ascending order by period, and duplicate periods will not be allowed.

Parameters: key the series key (null not permitted).

Method Detail

add

public void add(RegularTimePeriod period, double open, double high, double low, double close)
Adds a data item to the series.

Parameters: period the period. open the open-value. high the high-value. low the low-value. close the close-value.

getDataItem

public ComparableObjectItem getDataItem(int index)
Returns the data item at the specified index.

Parameters: index the item index.

Returns: The data item.

getPeriod

public RegularTimePeriod getPeriod(int index)
Returns the time period for the specified item.

Parameters: index the item index.

Returns: The time period.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.