org.jfree.data
Interface HighLowDataset

All Superinterfaces:
Dataset, SeriesDataset, XYDataset
All Known Implementing Classes:
CombinedDataset, DefaultHighLowDataset, SubSeriesDataset

public interface HighLowDataset
extends XYDataset

An interface that defines data in the form of (x, high, low, open, close) tuples.

Example: JFreeChart used this interface to obtain data for high-low-open-close plots.

Author:
David Gilbert

Method Summary
 java.lang.Number getCloseValue(int series, int item)
          Returns the y-value for the specified series and item.
 java.lang.Number getHighValue(int series, int item)
          Returns the high-value for the specified series and item.
 java.lang.Number getLowValue(int series, int item)
          Returns the low-value for the specified series and item.
 java.lang.Number getOpenValue(int series, int item)
          Returns the open-value for the specified series and item.
 java.lang.Number getVolumeValue(int series, int item)
          Returns the volume for the specified series and item.
 
Methods inherited from interface org.jfree.data.XYDataset
getItemCount, getXValue, getYValue
 
Methods inherited from interface org.jfree.data.SeriesDataset
getSeriesCount, getSeriesName
 
Methods inherited from interface org.jfree.data.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
 

Method Detail

getHighValue

public java.lang.Number getHighValue(int series,
                                     int item)
Returns the high-value for the specified series and item.

Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
the high-value for the specified series and item.

getLowValue

public java.lang.Number getLowValue(int series,
                                    int item)
Returns the low-value for the specified series and item.

Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
the low-value for the specified series and item.

getOpenValue

public java.lang.Number getOpenValue(int series,
                                     int item)
Returns the open-value for the specified series and item.

Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
the open-value for the specified series and item.

getCloseValue

public java.lang.Number getCloseValue(int series,
                                      int item)
Returns the y-value for the specified series and item.

Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
the y-value for the specified series and item.

getVolumeValue

public java.lang.Number getVolumeValue(int series,
                                       int item)
Returns the volume for the specified series and item.

Parameters:
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
the volume for the specified series and item.