Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.time

Class TimePeriodValuesCollection

Implemented Interfaces:
Cloneable, Dataset, DomainInfo, EventListener, IntervalXYDataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, 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.

Constructor Summary

TimePeriodValuesCollection()
Constructs an empty dataset.
TimePeriodValuesCollection(TimePeriodValues series)
Constructs a dataset containing a single series.

Method Summary

void
addSeries(TimePeriodValues series)
Adds a series to the collection.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
Range
getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
boolean
getDomainIsPointsInTime()
Deprecated. This flag is no longer used by JFreeChart (as of version 1.0.3).
double
getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
double
getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
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.
TimePeriodValues
getSeries(int series)
Returns a series.
int
getSeriesCount()
Returns the number of series in the collection.
Comparable
getSeriesKey(int series)
Returns the key for a series.
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.
Number
getX(int series, int item)
Returns the x-value for the specified series and item.
TimePeriodAnchor
getXPosition()
Returns the position of the X value within each time period.
Number
getY(int series, int item)
Returns the y-value for the specified series and item.
void
removeSeries(int index)
Removes a series from the collection.
void
removeSeries(TimePeriodValues series)
Removes the specified series from the collection.
void
setDomainIsPointsInTime(boolean flag)
Deprecated. This flag is no longer used by JFreeChart (as of version 1.0.3).
void
setXPosition(TimePeriodAnchor position)
Sets the position of the x axis within each time period.

Methods inherited from class org.jfree.data.xy.AbstractIntervalXYDataset

getEndXValue, getEndYValue, getStartXValue, getStartYValue

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder, getXValue, getYValue

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

getSeriesCount, getSeriesKey, indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

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 Details

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

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

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.

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.

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.

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.
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
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.
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.

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.

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.

getXPosition

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

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.

removeSeries

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

removeSeries

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

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

Overview Package Class Use Source Tree Index Deprecated About