org.jfree.data.time

Class TimeTableXYDataset

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

Implemented Interfaces:: Cloneable, EventListener, PublicCloneable, Dataset, DomainInfo, IntervalXYDataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, TableXYDataset, XYDataset

public class TimeTableXYDataset

extends AbstractIntervalXYDataset

implements Cloneable, PublicCloneable, IntervalXYDataset, DomainInfo, TableXYDataset

A dataset for regular time periods that implements the TableXYDataset interface.

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
`void`	`add(TimePeriod period, Number y, String seriesName, boolean notify)` Adds a new data item to the dataset.
`void`	`add(TimePeriod period, double y, String seriesName)` Adds a new data item to the dataset and sends a `DatasetChangeEvent` to all registered listeners.
`Object`	`clone()` Returns a clone of this dataset.
`boolean`	`equals(Object obj)` Tests this dataset for equality with an arbitrary object.
`Range`	`getDomainBounds(boolean includeInterval)` Returns the range of the values in this dataset's domain.
`boolean`	`getDomainIsPointsInTime()` Returns a flag that controls whether the domain is treated as 'points in time'.
`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.
`double`	`getEndXValue(int series, int item)` Returns the end x-value (as a double primitive) for an item within a series.
`Number`	`getEndY(int series, int item)` Returns the ending Y value for the specified series and item.
`int`	`getItemCount()` Returns the number of items in ALL series.
`int`	`getItemCount(int series)` Returns the number of items in a series.
`int`	`getSeriesCount()` Returns the number of series in the dataset.
`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.
`double`	`getStartXValue(int series, int item)` Returns the start x-value (as a double primitive) for an item within a series.
`Number`	`getStartY(int series, int item)` Returns the starting Y value for the specified series and item.
`TimePeriod`	`getTimePeriod(int item)` Returns the time period for the specified item.
`Number`	`getX(int series, int item)` Returns the x-value for an item within a series.
`TimePeriodAnchor`	`getXPosition()` Returns the position within each time period that is used for the X value.
`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 an item within a series.
`void`	`remove(TimePeriod period, String seriesName)` Removes an existing data item from the dataset.
`void`	`remove(TimePeriod period, String seriesName, boolean notify)` Removes an existing data item from the dataset.
`void`	`setDomainIsPointsInTime(boolean flag)` Sets a flag that controls whether the domain is treated as 'points in time', or time periods.
`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.

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`

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

add

public void add(TimePeriod period,
                Number y,
                String seriesName,
                boolean notify)

Adds a new data item to the dataset.
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.

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.

clone

public Object clone()
            throws CloneNotSupportedException

Returns a clone of this dataset.
Overrides:
clone in interface AbstractDataset
Returns:
A clone.

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.
Specified by:
getDomainBounds in interface DomainInfo
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.

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 within a series (zero-based index).
Returns:
The ending X value for the specified series and item.

getEndXValue

public double getEndXValue(int series,
                           int item)

Returns the end x-value (as a double primitive) for an item within a series.
Specified by:
getEndXValue in interface IntervalXYDataset
Overrides:
getEndXValue in interface AbstractIntervalXYDataset
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.
Specified by:
getEndY in interface IntervalXYDataset
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.
Specified by:
getItemCount in interface TableXYDataset
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).
Specified by:
getItemCount in interface XYDataset
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.
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 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.
Specified by:
getStartX in interface IntervalXYDataset
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.

getStartXValue

public double getStartXValue(int series,
                             int item)

Returns the start x-value (as a double primitive) for an item within a series.
Specified by:
getStartXValue in interface IntervalXYDataset
Overrides:
getStartXValue in interface AbstractIntervalXYDataset
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.
Specified by:
getStartY in interface IntervalXYDataset
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.
Specified by:
getX in interface XYDataset
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).

getXValue

public double getXValue(int series,
                        int item)

Returns the x-value (as a double primitive) for an item within a series.
Specified by:
getXValue in interface XYDataset
Overrides:
getXValue in interface AbstractXYDataset
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.
Specified by:
getY in interface XYDataset
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).

remove

public void remove(TimePeriod period,
                   String seriesName,
                   boolean notify)

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).
notify - whether dataset listener are notified or not.

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.

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

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

org.jfree.data.time

Class TimeTableXYDataset

Constructor Summary

Method Summary

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

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

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

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

Constructor Details

TimeTableXYDataset

TimeTableXYDataset

TimeTableXYDataset

Method Details

add

add

clone

equals

getDomainBounds

getDomainIsPointsInTime

getDomainLowerBound

getDomainUpperBound

getEndX

getEndXValue

getEndY

getItemCount

getItemCount

getSeriesCount

getSeriesKey

getStartX

getStartXValue

getStartY

getTimePeriod

getX

getXPosition

getXValue

getY

remove

remove

setDomainIsPointsInTime

setXPosition