Package org.jfree.data.time

Class TimePeriodValuesCollection

java.lang.Object
org.jfree.data.general.AbstractDataset
org.jfree.data.general.AbstractSeriesDataset
org.jfree.data.xy.AbstractXYDataset
org.jfree.data.xy.AbstractIntervalXYDataset
org.jfree.data.time.TimePeriodValuesCollection
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, DomainInfo, Dataset, SeriesChangeListener, SeriesDataset, IntervalXYDataset, XYDataset
public class TimePeriodValuesCollection extends AbstractIntervalXYDataset implements IntervalXYDataset, DomainInfo, Serializable
A collection of TimePeriodValues objects.

This class implements the XYDataset interface, as well as the extended IntervalXYDataset interface. This makes it a convenient dataset for use with the XYPlot class.

See Also:

  • Constructor Details

  • Method Details

    • getXPosition

      public TimePeriodAnchor getXPosition()
      Returns the position of the X value within each time period.
      Returns:
      The position (never null).
      See Also:

    • setXPosition

      public void setXPosition(TimePeriodAnchor position)
      Sets the position of the x axis within each time period.
      Parameters:
      position - the position (null not permitted).
      See Also:

    • getSeriesCount

      public int getSeriesCount()
      Returns the number of series in the collection.
      Specified by:
      getSeriesCount in interface SeriesDataset
      Specified by:
      getSeriesCount in class AbstractSeriesDataset
      Returns:
      The series count.

    • getSeries

      public TimePeriodValues getSeries(int series)
      Returns a series.
      Parameters:
      series - the index of the series (zero-based).
      Returns:
      The series.

    • getSeriesKey

      public Comparable getSeriesKey(int series)
      Returns the key for a series.
      Specified by:
      getSeriesKey in interface SeriesDataset
      Specified by:
      getSeriesKey in class AbstractSeriesDataset
      Parameters:
      series - the index of the series (zero-based).
      Returns:
      The key for a series.

    • addSeries

      public void addSeries(TimePeriodValues series)
      Adds a series to the collection. A DatasetChangeEvent is sent to all registered listeners.
      Parameters:
      series - the time series.

    • removeSeries

      public void removeSeries(TimePeriodValues series)
      Removes the specified series from the collection.
      Parameters:
      series - the series to remove (null not permitted).

    • removeSeries

      public void removeSeries(int index)
      Removes a series from the collection.
      Parameters:
      index - the series index (zero-based).

    • getItemCount

      public int getItemCount(int series)
      Returns the number of items in the specified series.

      This method is provided for convenience.

      Specified by:
      getItemCount in interface XYDataset
      Parameters:
      series - the index of the series of interest (zero-based).
      Returns:
      The number of items in the specified series.

    • getX

      public Number getX(int series, int item)
      Returns the x-value for the specified series and item.
      Specified by:
      getX in interface XYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The x-value for the specified series and item.

    • getStartX

      public Number getStartX(int series, int item)
      Returns the starting X value for the specified series and item.
      Specified by:
      getStartX in interface IntervalXYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The starting X value for the specified series and item.

    • getEndX

      public Number getEndX(int series, int item)
      Returns the ending X value for the specified series and item.
      Specified by:
      getEndX in interface IntervalXYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The ending X value for the specified series and item.

    • getY

      public Number getY(int series, int item)
      Returns the y-value for the specified series and item.
      Specified by:
      getY in interface XYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The y-value for the specified series and item.

    • getStartY

      public Number getStartY(int series, int item)
      Returns the starting Y value for the specified series and item.
      Specified by:
      getStartY in interface IntervalXYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The starting Y value for the specified series and item.

    • getEndY

      public Number getEndY(int series, int item)
      Returns the ending Y value for the specified series and item.
      Specified by:
      getEndY in interface IntervalXYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The ending Y value for the specified series and item.

    • getDomainLowerBound

      public double getDomainLowerBound(boolean includeInterval)
      Returns the minimum x-value in the dataset.
      Specified by:
      getDomainLowerBound in interface DomainInfo
      Parameters:
      includeInterval - a flag that determines whether or not the x-interval is taken into account.
      Returns:
      The minimum value.

    • getDomainUpperBound

      public double getDomainUpperBound(boolean includeInterval)
      Returns the maximum x-value in the dataset.
      Specified by:
      getDomainUpperBound in interface DomainInfo
      Parameters:
      includeInterval - a flag that determines whether or not the x-interval is taken into account.
      Returns:
      The maximum value.

    • getDomainBounds

      public Range getDomainBounds(boolean includeInterval)
      Returns the range of the values in this dataset's domain.
      Specified by:
      getDomainBounds in interface DomainInfo
      Parameters:
      includeInterval - a flag that determines whether or not the x-interval is taken into account.
      Returns:
      The range.

    • equals

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