org.jfree.data.xy

Class DefaultTableXYDataset

public class DefaultTableXYDataset extends AbstractIntervalXYDataset implements TableXYDataset, IntervalXYDataset, DomainInfo, PublicCloneable

An XYDataset where every series shares the same x-values (required for generating stacked area charts).
Constructor Summary
DefaultTableXYDataset()
Creates a new empty dataset.
DefaultTableXYDataset(boolean autoPrune)
Creates a new empty dataset.
Method Summary
voidaddSeries(XYSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
protected booleancanPrune(Number x)
Returns true if all the y-values for the specified x-value are null and false otherwise.
Objectclone()
Returns an independent copy of this dataset.
booleanequals(Object obj)
Tests this collection for equality with an arbitrary object.
RangegetDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
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.
doublegetIntervalPositionFactor()
Returns the interval position factor.
doublegetIntervalWidth()
returns the full interval width.
intgetItemCount()
Returns the number of x values in the dataset.
intgetItemCount(int series)
Returns the number of items in the specified series.
XYSeriesgetSeries(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.
NumbergetY(int series, int index)
Returns the y-value for the specified series and item.
inthashCode()
Returns a hash code.
booleanisAutoPrune()
Returns the flag that controls whether or not x-values are removed from the dataset when the corresponding y-values are all null.
booleanisAutoWidth()
Returns whether the interval width is automatically calculated or not.
voidprune()
Removes all x-values for which all the y-values are null.
voidremoveAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
voidremoveAllValuesForX(Number x)
Removes the items from all series for a given x value.
voidremoveSeries(XYSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
voidremoveSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
voidseriesChanged(SeriesChangeEvent event)
This method receives notification when a series belonging to the dataset changes.
voidsetAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically calculated or not.
voidsetIntervalPositionFactor(double d)
Sets the interval position factor.
voidsetIntervalWidth(double d)
Sets the interval width to a fixed value, and sends a DatasetChangeEvent to all registered listeners.
voidupdateXPoints()
Updates the x-values for all the series in the dataset.

Constructor Detail

DefaultTableXYDataset

public DefaultTableXYDataset()
Creates a new empty dataset.

DefaultTableXYDataset

public DefaultTableXYDataset(boolean autoPrune)
Creates a new empty dataset.

Parameters: autoPrune a flag that controls whether or not x-values are removed whenever the corresponding y-values are all null.

Method Detail

addSeries

public void addSeries(XYSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners. The series should be configured to NOT allow duplicate x-values.

Parameters: series the series (null not permitted).

canPrune

protected boolean canPrune(Number x)
Returns true if all the y-values for the specified x-value are null and false otherwise.

Parameters: x the x-value.

Returns: A boolean.

clone

public Object clone()
Returns an independent copy of this dataset.

Returns: A clone.

Throws: CloneNotSupportedException if there is some reason that cloning cannot be performed.

equals

public boolean equals(Object obj)
Tests this collection 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.

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.

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.

getIntervalPositionFactor

public double getIntervalPositionFactor()
Returns the interval position factor.

Returns: The interval position factor.

getIntervalWidth

public double getIntervalWidth()
returns the full interval width.

Returns: The interval width to use.

getItemCount

public int getItemCount()
Returns the number of x values in the dataset.

Returns: The number of x values in the dataset.

getItemCount

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

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

Returns: The number of items in the specified series.

getSeries

public XYSeries getSeries(int series)
Returns a series.

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

Returns: The series (never null).

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

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.

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.

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.

getY

public Number getY(int series, int index)
Returns the y-value for the specified series and item.

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

Returns: The y-value for the specified series and item (possibly null).

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

isAutoPrune

public boolean isAutoPrune()
Returns the flag that controls whether or not x-values are removed from the dataset when the corresponding y-values are all null.

Returns: A boolean.

isAutoWidth

public boolean isAutoWidth()
Returns whether the interval width is automatically calculated or not.

Returns: A flag that determines whether or not the interval width is automatically calculated.

prune

public void prune()
Removes all x-values for which all the y-values are null.

removeAllSeries

public void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

removeAllValuesForX

public void removeAllValuesForX(Number x)
Removes the items from all series for a given x value.

Parameters: x the x-value.

removeSeries

public void removeSeries(XYSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters: series the series (null not permitted).

removeSeries

public void removeSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters: series the series (zero based index).

seriesChanged

public void seriesChanged(SeriesChangeEvent event)
This method receives notification when a series belonging to the dataset changes. It responds by updating the x-points for the entire dataset and sending a DatasetChangeEvent to all registered listeners.

Parameters: event information about the change.

setAutoWidth

public void setAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically calculated or not.

Parameters: b a boolean.

setIntervalPositionFactor

public void setIntervalPositionFactor(double d)
Sets the interval position factor. Must be between 0.0 and 1.0 inclusive. If the factor is 0.5, the gap is in the middle of the x values. If it is lesser than 0.5, the gap is farther to the left and if greater than 0.5 it gets farther to the right.

Parameters: d the new interval position factor.

setIntervalWidth

public void setIntervalWidth(double d)
Sets the interval width to a fixed value, and sends a DatasetChangeEvent to all registered listeners.

Parameters: d the new interval width (must be > 0).

updateXPoints

public void updateXPoints()
Updates the x-values for all the series in the dataset.