Package org.jfree.data.xy
Class DefaultOHLCDataset
- java.lang.Object
-
- org.jfree.data.general.AbstractDataset
-
- org.jfree.data.general.AbstractSeriesDataset
-
- org.jfree.data.xy.AbstractXYDataset
-
- org.jfree.data.xy.DefaultOHLCDataset
-
- All Implemented Interfaces:
java.io.ObjectInputValidation
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,PublicCloneable
,Dataset
,SeriesChangeListener
,SeriesDataset
,OHLCDataset
,XYDataset
public class DefaultOHLCDataset extends AbstractXYDataset implements OHLCDataset, PublicCloneable
A simple implementation of theOHLCDataset
interface. This implementation supports only one series.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private OHLCDataItem[]
data
Storage for the data items.private java.lang.Comparable
key
The series key.
-
Constructor Summary
Constructors Constructor Description DefaultOHLCDataset(java.lang.Comparable key, OHLCDataItem[] data)
Creates a new dataset.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns an independent copy of this dataset.boolean
equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.java.lang.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.java.lang.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.java.lang.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.java.lang.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.java.lang.Comparable
getSeriesKey(int series)
Returns the series key.java.lang.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.java.lang.Number
getX(int series, int item)
Returns the x-value for a data item.java.util.Date
getXDate(int series, int item)
Returns the x-value for a data item as a date.java.lang.Number
getY(int series, int item)
Returns the y-value.void
sortDataByDate()
Sorts the data into ascending order by date.-
Methods inherited from class org.jfree.data.xy.AbstractXYDataset
getDomainOrder, getXValue, getYValue
-
Methods inherited from class org.jfree.data.general.AbstractSeriesDataset
indexOf, seriesChanged
-
Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, canEqual, fireDatasetChanged, getGroup, getNotify, hashCode, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
-
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
-
Methods inherited from interface org.jfree.data.xy.XYDataset
getDomainOrder, getXValue, getYValue
-
-
-
-
Field Detail
-
key
private java.lang.Comparable key
The series key.
-
data
private OHLCDataItem[] data
Storage for the data items.
-
-
Constructor Detail
-
DefaultOHLCDataset
public DefaultOHLCDataset(java.lang.Comparable key, OHLCDataItem[] data)
Creates a new dataset.- Parameters:
key
- the series key.data
- the data items.
-
-
Method Detail
-
getSeriesKey
public java.lang.Comparable getSeriesKey(int series)
Returns the series key.- Specified by:
getSeriesKey
in interfaceSeriesDataset
- Specified by:
getSeriesKey
in classAbstractSeriesDataset
- Parameters:
series
- the series index (ignored).- Returns:
- The series key.
-
getX
public java.lang.Number getX(int series, int item)
Returns the x-value for a data item.
-
getXDate
public java.util.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.
-
getY
public java.lang.Number getY(int series, int item)
Returns the y-value.
-
getHigh
public java.lang.Number getHigh(int series, int item)
Returns the high value.- Specified by:
getHigh
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (zero-based).- Returns:
- The high value.
-
getHighValue
public double getHighValue(int series, int item)
Returns the high-value (as a double primitive) for an item within a series.- Specified by:
getHighValue
in interfaceOHLCDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The high-value.
-
getLow
public java.lang.Number getLow(int series, int item)
Returns the low value.- Specified by:
getLow
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (zero-based).- Returns:
- The low value.
-
getLowValue
public double getLowValue(int series, int item)
Returns the low-value (as a double primitive) for an item within a series.- Specified by:
getLowValue
in interfaceOHLCDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The low-value.
-
getOpen
public java.lang.Number getOpen(int series, int item)
Returns the open value.- Specified by:
getOpen
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (zero-based).- Returns:
- The open value.
-
getOpenValue
public double getOpenValue(int series, int item)
Returns the open-value (as a double primitive) for an item within a series.- Specified by:
getOpenValue
in interfaceOHLCDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The open-value.
-
getClose
public java.lang.Number getClose(int series, int item)
Returns the close value.- Specified by:
getClose
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (zero-based).- Returns:
- The close value.
-
getCloseValue
public double getCloseValue(int series, int item)
Returns the close-value (as a double primitive) for an item within a series.- Specified by:
getCloseValue
in interfaceOHLCDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The close-value.
-
getVolume
public java.lang.Number getVolume(int series, int item)
Returns the trading volume.- Specified by:
getVolume
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (zero-based).- Returns:
- The trading volume.
-
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 interfaceOHLCDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The volume-value.
-
getSeriesCount
public int getSeriesCount()
Returns the series count.- Specified by:
getSeriesCount
in interfaceSeriesDataset
- Specified by:
getSeriesCount
in classAbstractSeriesDataset
- Returns:
- 1.
-
getItemCount
public int getItemCount(int series)
Returns the item count for the specified series.- Specified by:
getItemCount
in interfaceXYDataset
- Parameters:
series
- the series index (ignored).- Returns:
- The item count.
-
sortDataByDate
public void sortDataByDate()
Sorts the data into ascending order by date.
-
equals
public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.- Overrides:
equals
in classAbstractDataset
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns an independent copy of this dataset.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractDataset
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if there is a cloning problem.
-
-