Package org.jfree.data.time.ohlc
Class OHLCSeriesCollection
- java.lang.Object
-
- org.jfree.data.general.AbstractDataset
-
- org.jfree.data.general.AbstractSeriesDataset
-
- org.jfree.data.xy.AbstractXYDataset
-
- org.jfree.data.time.ohlc.OHLCSeriesCollection
-
- All Implemented Interfaces:
java.io.ObjectInputValidation
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,Dataset
,SeriesChangeListener
,SeriesDataset
,OHLCDataset
,XYDataset
public class OHLCSeriesCollection extends AbstractXYDataset implements OHLCDataset, java.io.Serializable
A collection ofOHLCSeries
objects.- See Also:
OHLCSeries
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List
data
Storage for the data series.private TimePeriodAnchor
xPosition
-
Constructor Summary
Constructors Constructor Description OHLCSeriesCollection()
Creates a new instance ofOHLCSeriesCollection
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSeries(OHLCSeries series)
Adds a series to the collection and sends aDatasetChangeEvent
to all registered listeners.java.lang.Object
clone()
Returns a clone of this instance.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 for an item within a series.double
getCloseValue(int series, int item)
Returns the close-value for an item within a series.java.lang.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.java.lang.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.java.lang.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.java.lang.Comparable
getSeriesKey(int series)
Returns the key for a series.java.lang.Number
getVolume(int series, int item)
Returnsnull
always, because this dataset doesn't record any volume data.double
getVolumeValue(int series, int item)
ReturnsDouble.NaN
always, because this dataset doesn't record any volume data.java.lang.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.TimePeriodAnchor
getXPosition()
Returns the position within each time period that is used for the X value when the collection is used as anXYDataset
.double
getXValue(int series, int item)
Returns the x-value for an item within a series.java.lang.Number
getY(int series, int item)
Returns the y-value for an item within a series.int
hashCode()
Returns a hash code for this instance.void
removeAllSeries()
Removes all the series from the collection and sends aDatasetChangeEvent
to all registered listeners.void
removeSeries(int index)
Removes the series with the specified index and sends aDatasetChangeEvent
to all registered listeners.boolean
removeSeries(OHLCSeries series)
Removes the specified series from the dataset and sends aDatasetChangeEvent
to all registered listeners.void
setXPosition(TimePeriodAnchor anchor)
Sets the position within each time period that is used for the X values when the collection is used as anXYDataset
, then sends aDatasetChangeEvent
is sent to all registered listeners.-
Methods inherited from class org.jfree.data.xy.AbstractXYDataset
getDomainOrder, 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, 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, getYValue
-
-
-
-
Field Detail
-
data
private java.util.List data
Storage for the data series.
-
xPosition
private TimePeriodAnchor xPosition
-
-
Method Detail
-
getXPosition
public TimePeriodAnchor getXPosition()
Returns the position within each time period that is used for the X value when the collection is used as anXYDataset
.- Returns:
- The anchor position (never
null
).
-
setXPosition
public void setXPosition(TimePeriodAnchor anchor)
Sets the position within each time period that is used for the X values when the collection is used as anXYDataset
, then sends aDatasetChangeEvent
is sent to all registered listeners.- Parameters:
anchor
- the anchor position (null
not permitted).
-
addSeries
public void addSeries(OHLCSeries series)
Adds a series to the collection and sends aDatasetChangeEvent
to all registered listeners.- Parameters:
series
- the series (null
not permitted).
-
getSeriesCount
public int getSeriesCount()
Returns the number of series in the collection.- Specified by:
getSeriesCount
in interfaceSeriesDataset
- Specified by:
getSeriesCount
in classAbstractSeriesDataset
- Returns:
- The series count.
-
getSeries
public OHLCSeries getSeries(int series)
Returns a series from the collection.- Parameters:
series
- the series index (zero-based).- Returns:
- The series.
- Throws:
java.lang.IllegalArgumentException
- ifseries
is not in the range0
togetSeriesCount() - 1
.
-
getSeriesKey
public java.lang.Comparable getSeriesKey(int series)
Returns the key for a series.- Specified by:
getSeriesKey
in interfaceSeriesDataset
- Specified by:
getSeriesKey
in classAbstractSeriesDataset
- Parameters:
series
- the series index (in the range0
togetSeriesCount() - 1
).- Returns:
- The key for a series.
- Throws:
java.lang.IllegalArgumentException
- ifseries
is not in the specified range.
-
getItemCount
public int getItemCount(int series)
Returns the number of items in the specified series.- Specified by:
getItemCount
in interfaceXYDataset
- Parameters:
series
- the series (zero-based index).- Returns:
- The item count.
- Throws:
java.lang.IllegalArgumentException
- ifseries
is not in the range0
togetSeriesCount() - 1
.
-
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 interfaceXYDataset
- Overrides:
getXValue
in classAbstractXYDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The x-value.
-
getX
public java.lang.Number getX(int series, int item)
Returns the x-value for an item within a series.
-
getY
public java.lang.Number getY(int series, int item)
Returns the y-value for an item within a series.
-
getOpenValue
public double getOpenValue(int series, int item)
Returns the open-value for an item within a series.- Specified by:
getOpenValue
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The open-value.
-
getOpen
public java.lang.Number getOpen(int series, int item)
Returns the open-value for an item within a series.- Specified by:
getOpen
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The open-value.
-
getCloseValue
public double getCloseValue(int series, int item)
Returns the close-value for an item within a series.- Specified by:
getCloseValue
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The close-value.
-
getClose
public java.lang.Number getClose(int series, int item)
Returns the close-value for an item within a series.- Specified by:
getClose
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The close-value.
-
getHighValue
public double getHighValue(int series, int item)
Returns the high-value for an item within a series.- Specified by:
getHighValue
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The high-value.
-
getHigh
public java.lang.Number getHigh(int series, int item)
Returns the high-value for an item within a series.- Specified by:
getHigh
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The high-value.
-
getLowValue
public double getLowValue(int series, int item)
Returns the low-value for an item within a series.- Specified by:
getLowValue
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The low-value.
-
getLow
public java.lang.Number getLow(int series, int item)
Returns the low-value for an item within a series.- Specified by:
getLow
in interfaceOHLCDataset
- Parameters:
series
- the series index.item
- the item index.- Returns:
- The low-value.
-
getVolume
public java.lang.Number getVolume(int series, int item)
Returnsnull
always, because this dataset doesn't record any volume data.- Specified by:
getVolume
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (ignored).- Returns:
null
.
-
getVolumeValue
public double getVolumeValue(int series, int item)
ReturnsDouble.NaN
always, because this dataset doesn't record any volume data.- Specified by:
getVolumeValue
in interfaceOHLCDataset
- Parameters:
series
- the series index (ignored).item
- the item index (ignored).- Returns:
Double.NaN
.
-
removeSeries
public void removeSeries(int index)
Removes the series with the specified index and sends aDatasetChangeEvent
to all registered listeners.- Parameters:
index
- the series index.
-
removeSeries
public boolean removeSeries(OHLCSeries series)
Removes the specified series from the dataset and sends aDatasetChangeEvent
to all registered listeners.- Parameters:
series
- the series (null
not permitted).- Returns:
true
if the series was removed, andfalse
otherwise.
-
removeAllSeries
public void removeAllSeries()
Removes all the series from the collection and sends aDatasetChangeEvent
to all registered listeners.
-
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.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classAbstractDataset
- Returns:
- A hash code.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of this instance.- Overrides:
clone
in classAbstractDataset
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if there is a problem.
-
-