org.jfree.data.time

Class TimeTableXYDataset

public class TimeTableXYDataset extends AbstractIntervalXYDataset implements Cloneable, PublicCloneable, IntervalXYDataset, DomainInfo, TableXYDataset

A dataset for regular time periods that implements the TableXYDataset interface. Note that the TableXYDataset interface requires all series to share the same set of x-values. When adding a new item (x, y) to one series, all other series automatically get a new item (x, null) unless a non-null item has already been specified.

See Also: TableXYDataset

Constructor Summary
TimeTableXYDataset()
Creates a new dataset.
TimeTableXYDataset(TimeZone zone)
Creates a new dataset with the given time zone.
TimeTableXYDataset(TimeZone zone, Locale locale)
Creates a new dataset with the given time zone and locale.
Method Summary
voidadd(TimePeriod period, double y, String seriesName)
Adds a new data item to the dataset and sends a DatasetChangeEvent to all registered listeners.
voidadd(TimePeriod period, Number y, String seriesName, boolean notify)
Adds a new data item to the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.
voidclear()
Removes all data items from the dataset and sends a DatasetChangeEvent to all registered listeners.
Objectclone()
Returns a clone of this dataset.
booleanequals(Object obj)
Tests this dataset 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.
doublegetEndXValue(int series, int item)
Returns the end x-value (as a double primitive) for an item within a series.
NumbergetEndY(int series, int item)
Returns the ending Y value for the specified series and item.
intgetItemCount()
Returns the number of items in ALL series.
intgetItemCount(int series)
Returns the number of items in a series.
intgetSeriesCount()
Returns the number of series in the dataset.
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.
doublegetStartXValue(int series, int item)
Returns the start x-value (as a double primitive) for an item within a series.
NumbergetStartY(int series, int item)
Returns the starting Y value for the specified series and item.
TimePeriodgetTimePeriod(int item)
Returns the time period for the specified item.
NumbergetX(int series, int item)
Returns the x-value for an item within a series.
TimePeriodAnchorgetXPosition()
Returns the position within each time period that is used for the X value.
doublegetXValue(int series, int item)
Returns the x-value (as a double primitive) for an item within a series.
NumbergetY(int series, int item)
Returns the y-value for an item within a series.
voidremove(TimePeriod period, String seriesName)
Removes an existing data item from the dataset.
voidremove(TimePeriod period, String seriesName, boolean notify)
Removes an existing data item from the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.
voidsetDomainIsPointsInTime(boolean flag)
Sets a flag that controls whether the domain is treated as 'points in time', or time periods.
voidsetXPosition(TimePeriodAnchor anchor)
Sets the position within each time period that is used for the X values, then sends a DatasetChangeEvent to all registered listeners.

Constructor Detail

TimeTableXYDataset

public TimeTableXYDataset()
Creates a new dataset.

TimeTableXYDataset

public TimeTableXYDataset(TimeZone zone)
Creates a new dataset with the given time zone.

Parameters: zone the time zone to use (null not permitted).

TimeTableXYDataset

public TimeTableXYDataset(TimeZone zone, Locale locale)
Creates a new dataset with the given time zone and locale.

Parameters: zone the time zone to use (null not permitted). locale the locale to use (null not permitted).

Method Detail

add

public void add(TimePeriod period, double y, String seriesName)
Adds a new data item to the dataset and sends a DatasetChangeEvent to all registered listeners.

Parameters: period the time period. y the value for this period. seriesName the name of the series to add the value.

See Also: TimeTableXYDataset

add

public void add(TimePeriod period, Number y, String seriesName, boolean notify)
Adds a new data item to the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.

Parameters: period the time period (null not permitted). y the value for this period (null permitted). seriesName the name of the series to add the value (null not permitted). notify whether dataset listener are notified or not.

See Also: TimeTableXYDataset

clear

public void clear()
Removes all data items from the dataset and sends a DatasetChangeEvent to all registered listeners.

Since: 1.0.7

clone

public Object clone()
Returns a clone of this dataset.

Returns: A clone.

Throws: CloneNotSupportedException if the dataset cannot be cloned.

equals

public boolean equals(Object obj)
Tests this dataset 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 controls whether or not the x-intervals are taken into account.

Returns: The range.

getDomainIsPointsInTime

public boolean getDomainIsPointsInTime()
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.

See Also: TimeTableXYDataset

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 within a series (zero-based index).

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

See Also: TimeTableXYDataset

getEndXValue

public double getEndXValue(int series, int item)
Returns the end x-value (as a double primitive) for an item within a series.

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

Returns: The value.

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 within a series (zero-based index).

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

getItemCount

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

Returns: The item count.

getItemCount

public int getItemCount(int series)
Returns the number of items in a series. This is the same value that is returned by getItemCount since all series share the same x-values (time periods).

Parameters: series the series (zero-based index, ignored).

Returns: The number of items within the series.

getSeriesCount

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

Returns: The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.

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

Returns: The key for the 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 within a series (zero-based index).

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

See Also: TimeTableXYDataset

getStartXValue

public double getStartXValue(int series, int item)
Returns the start x-value (as a double primitive) for an item within a series.

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

Returns: The value.

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 within a series (zero-based index).

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

getTimePeriod

public TimePeriod getTimePeriod(int item)
Returns the time period for the specified item. Bear in mind that all series share the same set of time periods.

Parameters: item the item index (0 <= i <= getItemCount).

Returns: The time period.

getX

public Number getX(int series, int item)
Returns the x-value for an item within a series. The x-values may or may not be returned in ascending order, that is up to the class implementing the interface.

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

Returns: The x-value.

getXPosition

public TimePeriodAnchor getXPosition()
Returns the position within each time period that is used for the X value.

Returns: The anchor position (never null).

See Also: setXPosition

getXValue

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 index (zero-based). item the item index (zero-based).

Returns: The value.

getY

public Number getY(int series, int item)
Returns the y-value for an item within a series.

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

Returns: The y-value (possibly null).

remove

public void remove(TimePeriod period, String seriesName)
Removes an existing data item from the dataset.

Parameters: period the (existing!) time period of the value to remove (null not permitted). seriesName the (existing!) series name to remove the value (null not permitted).

See Also: TimeTableXYDataset

remove

public void remove(TimePeriod period, String seriesName, boolean notify)
Removes an existing data item from the dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.

Parameters: period the (existing!) time period of the value to remove (null not permitted). seriesName the (existing!) series name to remove the value (null not permitted). notify whether dataset listener are notified or not.

See Also: TimeTableXYDataset

setDomainIsPointsInTime

public void setDomainIsPointsInTime(boolean flag)
Sets a flag that controls whether the domain is treated as 'points in time', or time periods. A DatasetChangeEvent is sent to all registered listeners.

Parameters: flag the new value of the flag.

See Also: getDomainIsPointsInTime

setXPosition

public void setXPosition(TimePeriodAnchor anchor)
Sets the position within each time period that is used for the X values, then sends a DatasetChangeEvent to all registered listeners.

Parameters: anchor the anchor position (null not permitted).

See Also: getXPosition