public class

DefaultTableXYDataset

extends AbstractIntervalXYDataset
implements DomainInfo IntervalXYDataset TableXYDataset
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.xy.DefaultTableXYDataset

Class Overview

An XYDataset where every series shares the same x-values (required for generating stacked area charts).

Summary

Public Constructors
DefaultTableXYDataset()
Creates a new empty dataset.
DefaultTableXYDataset(boolean autoPrune)
Creates a new empty dataset.
Public Methods
void addSeries(XYSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Object clone()
Returns an independent copy of this dataset.
boolean equals(Object obj)
Tests this collection for equality with an arbitrary object.
Range getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
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.
double getIntervalPositionFactor()
Returns the interval position factor.
double getIntervalWidth()
returns the full interval width.
int getItemCount(int series)
Returns the number of items in the specified series.
int getItemCount()
Returns the number of x values in the dataset.
XYSeries 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.
Number getY(int series, int index)
Returns the y-value for the specified series and item.
int hashCode()
Returns a hash code.
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.
boolean isAutoWidth()
Returns whether the interval width is automatically calculated or not.
void prune()
Removes all x-values for which all the y-values are null.
void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeAllValuesForX(Number x)
Removes the items from all series for a given x value.
void removeSeries(XYSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void seriesChanged(SeriesChangeEvent event)
This method receives notification when a series belonging to the dataset changes.
void setAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically calculated or not.
void setIntervalPositionFactor(double d)
Sets the interval position factor.
void setIntervalWidth(double d)
Sets the interval width to a fixed value, and sends a DatasetChangeEvent to all registered listeners.
void updateXPoints()
Updates the x-values for all the series in the dataset.
Protected Methods
boolean canPrune(Number x)
Returns true if all the y-values for the specified x-value are null and false otherwise.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
From class org.jfree.data.xy.AbstractXYDataset
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.DomainInfo
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset
From interface org.jfree.data.xy.IntervalXYDataset
From interface org.jfree.data.xy.TableXYDataset
From interface org.jfree.data.xy.XYDataset

Public Constructors

public DefaultTableXYDataset ()

Creates a new empty dataset.

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.

Public Methods

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

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.

public boolean equals (Object obj)

Tests this collection for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

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.

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.

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.

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.

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.

public double getIntervalPositionFactor ()

Returns the interval position factor.

Returns
  • The interval position factor.

public double getIntervalWidth ()

returns the full interval width.

Returns
  • The interval width to use.

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.

public int getItemCount ()

Returns the number of x values in the dataset.

Returns
  • The number of x values in the dataset.

public XYSeries getSeries (int series)

Returns a series.

Parameters
series the series (zero-based index).
Returns
  • The series (never null).

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The series count.

public Comparable getSeriesKey (int series)

Returns the key for a series.

Parameters
series the series (zero-based index).
Returns
  • The key for a series.

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.

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.

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.

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

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

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.

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.

public void prune ()

Removes all x-values for which all the y-values are null.

public void removeAllSeries ()

Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

public void removeAllValuesForX (Number x)

Removes the items from all series for a given x value.

Parameters
x the x-value.

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

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

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.

public void setAutoWidth (boolean b)

Sets the flag that indicates whether the interval width is automatically calculated or not.

Parameters
b a boolean.

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.

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

public void updateXPoints ()

Updates the x-values for all the series in the dataset.

Protected Methods

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.