OHLCSeries

extends ComparableObjectSeries

java.lang.Object
↳	org.jfree.data.general.Series
	↳	org.jfree.data.ComparableObjectSeries
		↳	org.jfree.data.time.ohlc.OHLCSeries

Class Overview

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

Summary

[Expand]

Inherited Fields

From class org.jfree.data.ComparableObjectSeries

Public Constructors
	OHLCSeries(Comparable key) Creates a new empty series.

Public Methods
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.

[Expand]

Inherited Methods

From class org.jfree.data.ComparableObjectSeries

void	add(ComparableObjectItem item, boolean notify) Adds a data item to the series and, if requested, sends a `SeriesChangeEvent` to all registered listeners.
void	add(Comparable x, Object y) Adds new data to the series and sends a `SeriesChangeEvent` to all registered listeners.
void	add(Comparable x, Object y, boolean notify) Adds new data to the series and, if requested, sends a `SeriesChangeEvent` to all registered listeners.
void	clear() Removes all data items from the series and, unless the series is already empty, sends a `SeriesChangeEvent` to all registered listeners.
void	delete(int start, int end) Deletes a range of items from the series and sends a `SeriesChangeEvent` to all registered listeners.
boolean	equals(Object obj) Tests this series for equality with an arbitrary object.
boolean	getAllowDuplicateXValues() Returns a flag that controls whether duplicate x-values are allowed.
boolean	getAutoSort() Returns the flag that controls whether the items in the series are automatically sorted.
ComparableObjectItem	getDataItem(int index) Return the data item with the specified index.
int	getItemCount() Returns the number of items in the series.
int	getMaximumItemCount() Returns the maximum number of items that will be retained in the series.
int	hashCode() Returns a hash code.
int	indexOf(Comparable x) Returns the index of the item with the specified x-value, or a negative index if the series does not contain an item with that x-value.
ComparableObjectItem	remove(Comparable x) Removes the item with the specified x-value and sends a `SeriesChangeEvent` to all registered listeners.
ComparableObjectItem	remove(int index) Removes the item at the specified index and sends a `SeriesChangeEvent` to all registered listeners.
void	setMaximumItemCount(int maximum) Sets the maximum number of items that will be retained in the series.
void	update(Comparable x, Object y) Updates an item in the series.
void	updateByIndex(int index, Object y) Updates the value of an item in the series and sends a `SeriesChangeEvent` to all registered listeners.

From class org.jfree.data.general.Series

void	addChangeListener(SeriesChangeListener listener) Registers an object with this series, to receive notification whenever the series changes.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener to the series.
Object	clone() Returns a clone of the series.
boolean	equals(Object obj) Tests the series for equality with another object.
void	firePropertyChange(String property, Object oldValue, Object newValue) Fires a property change event.
void	fireSeriesChanged() General method for signalling to registered listeners that the series has been changed.
String	getDescription() Returns a description of the series.
abstract int	getItemCount() Returns the number of data items in the series.
Comparable	getKey() Returns the key for the series.
boolean	getNotify() Returns the flag that controls whether or not change events are sent to registered listeners.
int	hashCode() Returns a hash code.
boolean	isEmpty() Returns `true` if the series contains no data items, and `false` otherwise.
void	notifyListeners(SeriesChangeEvent event) Sends a change event to all registered listeners.
void	removeChangeListener(SeriesChangeListener listener) Deregisters an object, so that it not longer receives notification whenever the series changes.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener from the series.
void	setDescription(String description) Sets the description of the series and sends a `PropertyChangeEvent` to all registered listeners.
void	setKey(Comparable key) Sets the key for the series and sends a `PropertyChangeEvent` (with the property name "Key") to all registered listeners.
void	setNotify(boolean notify) Sets the flag that controls whether or not change events are sent to registered listeners.

From class java.lang.Object

Public Constructors

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).

Public Methods

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.

public ComparableObjectItem getDataItem (int index)

Returns the data item at the specified index.

Parameters

index	the item index.

Returns

The data item.

public RegularTimePeriod getPeriod (int index)

Returns the time period for the specified item.

Parameters

index	the item index.

Returns

The time period.

Classes

OHLCSeries

Class Overview

See Also

Summary

Public Constructors

public OHLCSeries (Comparable key)

Parameters

Public Methods

public void add (RegularTimePeriod period, double open, double high, double low, double close)

Parameters

public ComparableObjectItem getDataItem (int index)

Parameters

Returns

public RegularTimePeriod getPeriod (int index)

Parameters

Returns