org.jfree.data.time.ohlc

Class OHLCSeries

Implemented Interfaces:
Cloneable, Serializable

public class OHLCSeries
extends ComparableObjectSeries

A list of (RegularTimePeriod, open, high, low, close) data items.
Since:
1.0.4
See Also:
OHLCSeriesCollection

Field Summary

Fields inherited from class org.jfree.data.ComparableObjectSeries

data

Constructor Summary

OHLCSeries(Comparable key)
Creates a new empty series.

Method Summary

void
add(RegularTimePeriod period, double open, double high, double low, double close)
Adds a data item to the series.
ComparableObjectItem
getDataItem(int index)
Returns the data item at the specified index.
RegularTimePeriod
getPeriod(int index)
Returns the time period for the specified item.

Methods inherited from class org.jfree.data.ComparableObjectSeries

add, add, add, clear, delete, equals, getAllowDuplicateXValues, getAutoSort, getDataItem, getItemCount, getMaximumItemCount, hashCode, indexOf, remove, remove, setMaximumItemCount, update, updateByIndex

Methods inherited from class org.jfree.data.general.Series

addChangeListener, addPropertyChangeListener, clone, equals, firePropertyChange, fireSeriesChanged, getDescription, getKey, getNotify, hashCode, notifyListeners, removeChangeListener, removePropertyChangeListener, setDescription, setKey, setNotify

Constructor Details

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 Details

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.
Overrides:
getDataItem in interface ComparableObjectSeries
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.