public class

DefaultOHLCDataset

extends AbstractXYDataset
implements OHLCDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.DefaultOHLCDataset

Class Overview

A simple implementation of the OHLCDataset interface. This implementation supports only one series.

Summary

Public Constructors
DefaultOHLCDataset(Comparable key, OHLCDataItem[] data)
Creates a new dataset.
Public Methods
Object clone()
Returns an independent copy of this dataset.
boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Number getClose(int series, int item)
Returns the close value.
double getCloseValue(int series, int item)
Returns the close-value (as a double primitive) for an item within a series.
Number getHigh(int series, int item)
Returns the high value.
double getHighValue(int series, int item)
Returns the high-value (as a double primitive) for an item within a series.
int getItemCount(int series)
Returns the item count for the specified series.
Number getLow(int series, int item)
Returns the low value.
double getLowValue(int series, int item)
Returns the low-value (as a double primitive) for an item within a series.
Number getOpen(int series, int item)
Returns the open value.
double getOpenValue(int series, int item)
Returns the open-value (as a double primitive) for an item within a series.
int getSeriesCount()
Returns the series count.
Comparable getSeriesKey(int series)
Returns the series key.
Number getVolume(int series, int item)
Returns the trading volume.
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 a data item.
Date getXDate(int series, int item)
Returns the x-value for a data item as a date.
Number getY(int series, int item)
Returns the y-value.
void sortDataByDate()
Sorts the data into ascending order by date.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.OHLCDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public DefaultOHLCDataset (Comparable key, OHLCDataItem[] data)

Creates a new dataset.

Parameters
key the series key.
data the data items.

Public Methods

public Object clone ()

Returns an independent copy of this dataset.

Returns
  • A clone.
Throws
CloneNotSupportedException

public boolean equals (Object obj)

Tests this instance for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Number getClose (int series, int item)

Returns the close value.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The close value.

public double getCloseValue (int series, int item)

Returns the close-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The close-value.

public Number getHigh (int series, int item)

Returns the high value.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The high value.

public double getHighValue (int series, int item)

Returns the high-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The high-value.

public int getItemCount (int series)

Returns the item count for the specified series.

Parameters
series the series index (ignored).
Returns
  • The item count.

public Number getLow (int series, int item)

Returns the low value.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The low value.

public double getLowValue (int series, int item)

Returns the low-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The low-value.

public Number getOpen (int series, int item)

Returns the open value.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The open value.

public double getOpenValue (int series, int item)

Returns the open-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The open-value.

public int getSeriesCount ()

Returns the series count.

Returns
  • 1.

public Comparable getSeriesKey (int series)

Returns the series key.

Parameters
series the series index (ignored).
Returns
  • The series key.

public Number getVolume (int series, int item)

Returns the trading volume.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The trading volume.

public double getVolumeValue (int series, int item)

Returns the volume-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The volume-value.

public Number getX (int series, int item)

Returns the x-value for a data item.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The x-value.

public Date getXDate (int series, int item)

Returns the x-value for a data item as a date.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The x-value as a date.

public Number getY (int series, int item)

Returns the y-value.

Parameters
series the series index (ignored).
item the item index (zero-based).
Returns
  • The y value.

public void sortDataByDate ()

Sorts the data into ascending order by date.