Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.time.ohlc

Class OHLCSeriesCollection

Implemented Interfaces:
Cloneable, Dataset, EventListener, ObjectInputValidation, OHLCDataset, Serializable, SeriesChangeListener, SeriesDataset, XYDataset
public class OHLCSeriesCollection
extends AbstractXYDataset
implements OHLCDataset, Serializable
A collection of OHLCSeries objects.
Since:
1.0.4
See Also:
OHLCSeries

Constructor Summary

OHLCSeriesCollection()
Creates a new instance of OHLCSeriesCollection.

Method Summary

void
addSeries(OHLCSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Object
clone()
Returns a clone of this instance.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
Number
getClose(int series, int item)
Returns the close-value for an item within a series.
double
getCloseValue(int series, int item)
Returns the close-value for an item within a series.
Number
getHigh(int series, int item)
Returns the high-value for an item within a series.
double
getHighValue(int series, int item)
Returns the high-value for an item within a series.
int
getItemCount(int series)
Returns the number of items in the specified series.
Number
getLow(int series, int item)
Returns the low-value for an item within a series.
double
getLowValue(int series, int item)
Returns the low-value for an item within a series.
Number
getOpen(int series, int item)
Returns the open-value for an item within a series.
double
getOpenValue(int series, int item)
Returns the open-value for an item within a series.
OHLCSeries
getSeries(int series)
Returns a series from the collection.
int
getSeriesCount()
Returns the number of series in the collection.
Comparable
getSeriesKey(int series)
Returns the key for a series.
Number
getVolume(int series, int item)
Returns the volume for the specified series and item.
double
getVolumeValue(int series, int item)
Returns the volume-value (as a double primitive) for an item within a series.
Number
getX(int series, int item)
Returns the x-value for an item within a series.
protected long
getX(RegularTimePeriod period)
Returns the x-value for a time period.
double
getXValue(int series, int item)
Returns the x-value for an item within a series.
Number
getY(int series, int item)
Returns the y-value for an item within a series.

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

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

getSeriesCount, getSeriesKey, indexOf, seriesChanged

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

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

OHLCSeriesCollection

public OHLCSeriesCollection()
Creates a new instance of OHLCSeriesCollection.

Method Details

addSeries

public void addSeries(OHLCSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (null not permitted).

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Overrides:
clone in interface AbstractDataset
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getClose

public Number getClose(int series,
                       int item)
Returns the close-value for an item within a series.
Specified by:
getClose in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The close-value.

getCloseValue

public double getCloseValue(int series,
                            int item)
Returns the close-value for an item within a series.
Specified by:
getCloseValue in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The close-value.

getHigh

public Number getHigh(int series,
                      int item)
Returns the high-value for an item within a series.
Specified by:
getHigh in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The high-value.

getHighValue

public double getHighValue(int series,
                           int item)
Returns the high-value for an item within a series.
Specified by:
getHighValue in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The high-value.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series.
Specified by:
getItemCount in interface XYDataset
Parameters:
series - the series (zero-based index).
Returns:
The item count.

getLow

public Number getLow(int series,
                     int item)
Returns the low-value for an item within a series.
Specified by:
getLow in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The low-value.

getLowValue

public double getLowValue(int series,
                          int item)
Returns the low-value for an item within a series.
Specified by:
getLowValue in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The low-value.

getOpen

public Number getOpen(int series,
                      int item)
Returns the open-value for an item within a series.
Specified by:
getOpen in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The open-value.

getOpenValue

public double getOpenValue(int series,
                           int item)
Returns the open-value for an item within a series.
Specified by:
getOpenValue in interface OHLCDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The open-value.

getSeries

public OHLCSeries getSeries(int series)
Returns a series from the collection.
Parameters:
series - the series index (zero-based).
Returns:
The series.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for a series.

getVolume

public Number getVolume(int series,
                        int item)
Returns the volume for the specified series and item.
Specified by:
getVolume in interface OHLCDataset
Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The value.

getVolumeValue

public double getVolumeValue(int series,
                             int item)
Returns the volume-value (as a double primitive) for an item within a series.
Specified by:
getVolumeValue in interface OHLCDataset
Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The volume-value.

getX

public Number getX(int series,
                   int item)
Returns the x-value for an item within a series.
Specified by:
getX in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getX

protected long getX(RegularTimePeriod period)
Returns the x-value for a time period.
Parameters:
period - the time period (null not permitted).
Returns:
The x-value.

getXValue

public double getXValue(int series,
                        int item)
Returns the x-value for an item within a series.
Specified by:
getXValue in interface XYDataset
Overrides:
getXValue in interface AbstractXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getY

public Number getY(int series,
                   int item)
Returns the y-value for an item within a series.
Specified by:
getY in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-value.

Overview Package Class Use Source Tree Index Deprecated About