Module platform

Package org.jfree.data.time.ohlc

Class OHLCSeries

java.lang.Object

org.jfree.data.general.Series

org.jfree.data.ComparableObjectSeries

org.jfree.data.time.ohlc.OHLCSeries

All Implemented Interfaces:

Serializable, Cloneable

public class OHLCSeries
extends ComparableObjectSeries

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

See Also:

• OHLCSeriesCollection
• Serialized Form

Field Summary

Fields inherited from class org.jfree.data.ComparableObjectSeries

data

Constructor Summary

Constructors

Constructor	Description
OHLCSeries(Comparable key)	Creates a new empty series.

Method Summary

Modifier and Type	Method	Description
void	add(OHLCItem item)	Adds a data item to the series.
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.
ComparableObjectItem	remove(int index)	Removes the item with the specified index.

Methods inherited from class org.jfree.data.ComparableObjectSeries

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

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

addChangeListener, addPropertyChangeListener, addVetoableChangeListener, clone, firePropertyChange, fireSeriesChanged, fireVetoableChange, getDescription, getKey, getNotify, isEmpty, notifyListeners, removeChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setDescription, setKey, setNotify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getPeriod

public RegularTimePeriod getPeriod(int index)

Returns the time period for the specified item.

Parameters:

index - the item index.

Returns:

The time period.

getDataItem

public ComparableObjectItem getDataItem(int index)

Returns the data item at the specified index.

Overrides:

getDataItem in class ComparableObjectSeries

Parameters:

index - the item index.

Returns:

The data item.

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.

add

public void add(OHLCItem item)

Adds a data item to the series. The values from the item passed to this method will be copied into a new object.

Parameters:

item - the item (null not permitted).

remove

public ComparableObjectItem remove(int index)

Removes the item with the specified index.

Overrides:

remove in class ComparableObjectSeries

Parameters:

index - the item index.

Returns:

The item removed.