public class

TimeSeriesCollection

extends AbstractIntervalXYDataset
implements Serializable DomainInfo IntervalXYDataset XYDataset
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.TimeSeriesCollection

Class Overview

A collection of time series 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.

Summary

Public Constructors
TimeSeriesCollection()
Constructs an empty dataset, tied to the default timezone.
TimeSeriesCollection(TimeZone zone)
Constructs an empty dataset, tied to a specific timezone.
TimeSeriesCollection(TimeSeries series)
Constructs a dataset containing a single series (more can be added), tied to the default timezone.
TimeSeriesCollection(TimeSeries series, TimeZone zone)
Constructs a dataset containing a single series (more can be added), tied to a specific timezone.
Public Methods
void addSeries(TimeSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
boolean equals(Object obj)
Tests this time series collection for equality with another object.
Range getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
boolean getDomainIsPointsInTime()
This method is deprecated. This flag is no longer used (as of 1.0.1).
double getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
DomainOrder getDomainOrder()
Returns the order of the domain values in this dataset.
double getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
synchronized Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.
Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.
int getItemCount(int series)
Returns the number of items in the specified series.
TimeSeries getSeries(int series)
Returns a series.
TimeSeries getSeries(Comparable key)
Returns the series with the specified key, or null if there is no such series.
List getSeries()
Returns a list of all the series in the collection.
int getSeriesCount()
Returns the number of series in the collection.
Comparable getSeriesKey(int series)
Returns the key for a series.
synchronized Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.
Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.
int[] getSurroundingItems(int series, long milliseconds)
Returns the indices of the two data items surrounding a particular millisecond value.
Number getX(int series, int item)
Returns the x-value for the specified series and item.
TimePeriodAnchor getXPosition()
Returns the position within each time period that is used for the X value when the collection is used as an XYDataset.
double getXValue(int series, int item)
Returns the x-value (as a double primitive) for an item within a series.
Number getY(int series, int item)
Returns the y-value for the specified series and item.
int hashCode()
Returns a hash code value for the object.
int indexOf(TimeSeries series)
Returns the index of the specified series, or -1 if that series is not present in the dataset.
void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(int index)
Removes a series from the collection.
void removeSeries(TimeSeries series)
Removes the specified series from the collection and sends a DatasetChangeEvent to all registered listeners.
void setDomainIsPointsInTime(boolean flag)
This method is deprecated. This flag is no longer used, as of 1.0.1. The includeInterval flag in methods such as getDomainBounds(boolean) makes this unnecessary.
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.
Protected Methods
synchronized long getX(RegularTimePeriod period)
Returns the x-value for a time period.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.DomainInfo
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.IntervalXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public TimeSeriesCollection ()

Constructs an empty dataset, tied to the default timezone.

public TimeSeriesCollection (TimeZone zone)

Constructs an empty dataset, tied to a specific timezone.

Parameters
zone the timezone (null permitted, will use TimeZone.getDefault() in that case).

public TimeSeriesCollection (TimeSeries series)

Constructs a dataset containing a single series (more can be added), tied to the default timezone.

Parameters
series the series (null permitted).

public TimeSeriesCollection (TimeSeries series, TimeZone zone)

Constructs a dataset containing a single series (more can be added), tied to a specific timezone.

Parameters
series a series to add to the collection (null permitted).
zone the timezone (null permitted, will use TimeZone.getDefault() in that case).

Public Methods

public void addSeries (TimeSeries series)

Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

public boolean equals (Object obj)

Tests this time series collection for equality with another object.

Parameters
obj the other object.
Returns
  • A boolean.

public Range getDomainBounds (boolean includeInterval)

Returns the range of the values in this dataset's domain.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The range.

public boolean getDomainIsPointsInTime ()

This method is deprecated.
This flag is no longer used (as of 1.0.1).

Returns a flag that controls whether the domain is treated as 'points in time'. This flag is used when determining the max and min values for the domain. If true, then only the x-values are considered for the max and min values. If false, then the start and end x-values will also be taken into consideration.

Returns
  • The flag.

public double getDomainLowerBound (boolean includeInterval)

Returns the minimum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The minimum value.

public DomainOrder getDomainOrder ()

Returns the order of the domain values in this dataset.

Returns

public double getDomainUpperBound (boolean includeInterval)

Returns the maximum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The maximum value.

public synchronized Number getEndX (int series, int item)

Returns the ending X value for the specified series and item.

Parameters
series The series (zero-based index).
item The item (zero-based index).
Returns
  • The value.

public Number getEndY (int series, int item)

Returns the ending Y value for the specified series and item.

Parameters
series te series (zero-based index).
item the item (zero-based index).
Returns
  • The value (possibly null).

public int getItemCount (int series)

Returns the number of items in the specified series. This method is provided for convenience.

Parameters
series the series index (zero-based).
Returns
  • The item count.

public TimeSeries getSeries (int series)

Returns a series.

Parameters
series the index of the series (zero-based).
Returns
  • The series.

public TimeSeries getSeries (Comparable key)

Returns the series with the specified key, or null if there is no such series.

Parameters
key the series key (null permitted).
Returns
  • The series with the given key.

public List getSeries ()

Returns a list of all the series in the collection.

Returns
  • The list (which is unmodifiable).

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The series count.

public Comparable getSeriesKey (int series)

Returns the key for a series.

Parameters
series the index of the series (zero-based).
Returns
  • The key for a series.

public synchronized Number getStartX (int series, int item)

Returns the starting X value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The value.

public Number getStartY (int series, int item)

Returns the starting Y value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The value (possibly null).

public int[] getSurroundingItems (int series, long milliseconds)

Returns the indices of the two data items surrounding a particular millisecond value.

Parameters
series the series index.
milliseconds the time.
Returns
  • An array containing the (two) indices of the items surrounding the time.

public Number getX (int series, int item)

Returns the x-value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The value.

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).

public double getXValue (int series, int item)

Returns the x-value (as a double primitive) for an item within a series.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The x-value.

public Number getY (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 value (possibly null).

public int hashCode ()

Returns a hash code value for the object.

Returns
  • The hashcode

public int indexOf (TimeSeries series)

Returns the index of the specified series, or -1 if that series is not present in the dataset.

Parameters
series the series (null not permitted).
Returns
  • The series index.

public void removeAllSeries ()

Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

public void removeSeries (int index)

Removes a series from the collection.

Parameters
index the series index (zero-based).

public void removeSeries (TimeSeries series)

Removes the specified series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

public void setDomainIsPointsInTime (boolean flag)

This method is deprecated.
This flag is no longer used, as of 1.0.1. The includeInterval flag in methods such as getDomainBounds(boolean) makes this unnecessary.

Sets a flag that controls whether the domain is treated as 'points in time', or time periods.

Parameters
flag the flag.

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).

Protected Methods

protected synchronized long getX (RegularTimePeriod period)

Returns the x-value for a time period.

Parameters
period the time period (null not permitted).
Returns
  • The x-value.