org.jfree.data.time

Class TimePeriodValuesCollection

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.

Constructor Summary
TimePeriodValuesCollection()
Constructs an empty dataset.
TimePeriodValuesCollection(TimePeriodValues series)
Constructs a dataset containing a single series.
Method Summary
voidaddSeries(TimePeriodValues series)
Adds a series to the collection.
booleanequals(Object obj)
Tests this instance for equality with an arbitrary object.
RangegetDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
booleangetDomainIsPointsInTime()
Returns a flag that controls whether the domain is treated as 'points in time'.
doublegetDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
doublegetDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
NumbergetEndX(int series, int item)
Returns the ending X value for the specified series and item.
NumbergetEndY(int series, int item)
Returns the ending Y value for the specified series and item.
intgetItemCount(int series)
Returns the number of items in the specified series.
TimePeriodValuesgetSeries(int series)
Returns a series.
intgetSeriesCount()
Returns the number of series in the collection.
ComparablegetSeriesKey(int series)
Returns the key for a series.
NumbergetStartX(int series, int item)
Returns the starting X value for the specified series and item.
NumbergetStartY(int series, int item)
Returns the starting Y value for the specified series and item.
NumbergetX(int series, int item)
Returns the x-value for the specified series and item.
TimePeriodAnchorgetXPosition()
Returns the position of the X value within each time period.
NumbergetY(int series, int item)
Returns the y-value for the specified series and item.
voidremoveSeries(TimePeriodValues series)
Removes the specified series from the collection.
voidremoveSeries(int index)
Removes a series from the collection.
voidsetDomainIsPointsInTime(boolean flag)
Sets a flag that controls whether the domain is treated as 'points in time', or time periods.
voidsetXPosition(TimePeriodAnchor position)
Sets the position of the x axis within each time period.

Constructor Detail

TimePeriodValuesCollection

public TimePeriodValuesCollection()
Constructs an empty dataset.

TimePeriodValuesCollection

public TimePeriodValuesCollection(TimePeriodValues series)
Constructs a dataset containing a single series. Additional series can be added.

Parameters: series the series (null ignored).

Method Detail

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.

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getDomainBounds

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.

getDomainIsPointsInTime

public boolean getDomainIsPointsInTime()

Deprecated: This flag is no longer used by JFreeChart (as of version 1.0.3).

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.

getDomainLowerBound

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.

getDomainUpperBound

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.

getEndX

public 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 ending X 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.

Parameters: series the series (zero-based index). item the item (zero-based index).

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

getItemCount

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

This method is provided for convenience.

Parameters: series the index of the series of interest (zero-based).

Returns: The number of items in the specified series.

getSeries

public TimePeriodValues getSeries(int series)
Returns a series.

Parameters: series the index of the series (zero-based).

Returns: The series.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.

Returns: The series count.

getSeriesKey

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.

getStartX

public 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 starting X 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.

Parameters: series the series (zero-based index). item the item (zero-based index).

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

getX

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 x-value for the specified series and item.

getXPosition

public TimePeriodAnchor getXPosition()
Returns the position of the X value within each time period.

Returns: The position (never null).

See Also: setXPosition

getY

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 y-value for the specified series and item.

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

setDomainIsPointsInTime

public void setDomainIsPointsInTime(boolean flag)

Deprecated: This flag is no longer used by JFreeChart (as of version 1.0.3).

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

Parameters: flag the new value of the flag.

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: getXPosition