OHLCSeriesCollection
org.jfree.data.time.ohlc

Class OHLCSeriesCollection

    • Constructor Detail

      • OHLCSeriesCollection

        public OHLCSeriesCollection()
        Creates a new instance of OHLCSeriesCollection.
    • 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 an XYDataset.
        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 an XYDataset, then sends a DatasetChangeEvent 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 a DatasetChangeEvent to all registered listeners.
        Parameters:
        series - the series (null not permitted).
      • getSeries

        public OHLCSeries getSeries(int series)
        Returns a series from the collection.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The series.
        Throws:
        IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.
      • 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.
        Throws:
        IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.
      • 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 class AbstractXYDataset
        Parameters:
        series - the series index.
        item - the item index.
        Returns:
        The x-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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • getVolume

        public Number getVolume(int series,               int item)
        Returns null always, because this dataset doesn't record any volume data.
        Specified by:
        getVolume in interface OHLCDataset
        Parameters:
        series - the series index (ignored).
        item - the item index (ignored).
        Returns:
        null.
      • getVolumeValue

        public double getVolumeValue(int series,                    int item)
        Returns Double.NaN always, because this dataset doesn't record any volume data.
        Specified by:
        getVolumeValue in interface OHLCDataset
        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 a DatasetChangeEvent to all registered listeners.
        Parameters:
        index - the series index.
      • removeSeries

        public boolean removeSeries(OHLCSeries series)
        Removes the specified series from the dataset and sends a DatasetChangeEvent to all registered listeners.
        Parameters:
        series - the series (null not permitted).
        Returns:
        true if the series was removed, and false otherwise.
      • removeAllSeries

        public void removeAllSeries()
        Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
      • equals

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

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class Object
        Returns:
        A hash code.

SCaVis 1.8 © jWork.org