Package org.jfree.data.xy
Class DefaultTableXYDataset
- 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
-
- All Implemented Interfaces:
java.io.ObjectInputValidation,java.io.Serializable,java.lang.Cloneable,java.util.EventListener,DomainInfo,Dataset,SeriesChangeListener,SeriesDataset,IntervalXYDataset,TableXYDataset,XYDataset,org.jfree.util.PublicCloneable
public class DefaultTableXYDataset extends AbstractIntervalXYDataset implements TableXYDataset, IntervalXYDataset, DomainInfo, org.jfree.util.PublicCloneable
AnXYDatasetwhere every series shares the same x-values (required for generating stacked area charts).- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultTableXYDataset()Creates a new empty dataset.DefaultTableXYDataset(boolean autoPrune)Creates a new empty dataset.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSeries(XYSeries series)Adds a series to the collection and sends aDatasetChangeEventto all registered listeners.protected booleancanPrune(java.lang.Number x)Returnstrueif all the y-values for the specified x-value arenullandfalseotherwise.java.lang.Objectclone()Returns an independent copy of this dataset.booleanequals(java.lang.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.java.lang.NumbergetEndX(int series, int item)Returns the ending X value for the specified series and item.java.lang.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.java.lang.ComparablegetSeriesKey(int series)Returns the key for a series.java.lang.NumbergetStartX(int series, int item)Returns the starting X value for the specified series and item.java.lang.NumbergetStartY(int series, int item)Returns the starting Y value for the specified series and item.java.lang.NumbergetX(int series, int item)Returns the x-value for the specified series and item.java.lang.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 allnull.booleanisAutoWidth()Returns whether the interval width is automatically calculated or not.voidprune()Removes all x-values for which all the y-values arenull.voidremoveAllSeries()Removes all the series from the collection and sends aDatasetChangeEventto all registered listeners.voidremoveAllValuesForX(java.lang.Number x)Removes the items from all series for a given x value.voidremoveSeries(int series)Removes a series from the collection and sends aDatasetChangeEventto all registered listeners.voidremoveSeries(XYSeries series)Removes a series from the collection and sends aDatasetChangeEventto 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 aDatasetChangeEventto all registered listeners.voidupdateXPoints()Updates the x-values for all the series in the dataset.-
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
indexOf
-
Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, fireDatasetChanged, getGroup, getNotify, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
-
Methods inherited from interface org.jfree.data.xy.IntervalXYDataset
getEndXValue, getEndYValue, getStartXValue, getStartYValue
-
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
-
Methods inherited from interface org.jfree.data.xy.XYDataset
getDomainOrder, getXValue, getYValue
-
-
-
-
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 allnull.
-
-
Method Detail
-
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 allnull.- Returns:
- A boolean.
-
addSeries
public void addSeries(XYSeries series)
Adds a series to the collection and sends aDatasetChangeEventto all registered listeners. The series should be configured to NOT allow duplicate x-values.- Parameters:
series- the series (nullnot permitted).
-
updateXPoints
public void updateXPoints()
Updates the x-values for all the series in the dataset.
-
getSeriesCount
public int getSeriesCount()
Returns the number of series in the collection.- Specified by:
getSeriesCountin interfaceSeriesDataset- Specified by:
getSeriesCountin classAbstractSeriesDataset- Returns:
- The series count.
-
getItemCount
public int getItemCount()
Returns the number of x values in the dataset.- Specified by:
getItemCountin interfaceTableXYDataset- Returns:
- The number of x values in the dataset.
-
getSeries
public XYSeries getSeries(int series)
Returns a series.- Parameters:
series- the series (zero-based index).- Returns:
- The series (never
null).
-
getSeriesKey
public java.lang.Comparable getSeriesKey(int series)
Returns the key for a series.- Specified by:
getSeriesKeyin interfaceSeriesDataset- Specified by:
getSeriesKeyin classAbstractSeriesDataset- Parameters:
series- the series (zero-based index).- Returns:
- The key for a series.
-
getItemCount
public int getItemCount(int series)
Returns the number of items in the specified series.- Specified by:
getItemCountin interfaceXYDataset- Parameters:
series- the series (zero-based index).- Returns:
- The number of items in the specified series.
-
getX
public java.lang.Number getX(int series, int item)
Returns the x-value for the specified series and item.
-
getStartX
public java.lang.Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.- Specified by:
getStartXin interfaceIntervalXYDataset- Parameters:
series- the series (zero-based index).item- the item (zero-based index).- Returns:
- The starting X value.
-
getEndX
public java.lang.Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.- Specified by:
getEndXin interfaceIntervalXYDataset- Parameters:
series- the series (zero-based index).item- the item (zero-based index).- Returns:
- The ending X value.
-
getY
public java.lang.Number getY(int series, int index)
Returns the y-value for the specified series and item.
-
getStartY
public java.lang.Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.- Specified by:
getStartYin interfaceIntervalXYDataset- Parameters:
series- the series (zero-based index).item- the item (zero-based index).- Returns:
- The starting Y value.
-
getEndY
public java.lang.Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.- Specified by:
getEndYin interfaceIntervalXYDataset- Parameters:
series- the series (zero-based index).item- the item (zero-based index).- Returns:
- The ending Y value.
-
removeAllSeries
public void removeAllSeries()
Removes all the series from the collection and sends aDatasetChangeEventto all registered listeners.
-
removeSeries
public void removeSeries(XYSeries series)
Removes a series from the collection and sends aDatasetChangeEventto all registered listeners.- Parameters:
series- the series (nullnot permitted).
-
removeSeries
public void removeSeries(int series)
Removes a series from the collection and sends aDatasetChangeEventto all registered listeners.- Parameters:
series- the series (zero based index).
-
removeAllValuesForX
public void removeAllValuesForX(java.lang.Number x)
Removes the items from all series for a given x value.- Parameters:
x- the x-value.
-
canPrune
protected boolean canPrune(java.lang.Number x)
Returnstrueif all the y-values for the specified x-value arenullandfalseotherwise.- Parameters:
x- the x-value.- Returns:
- A boolean.
-
prune
public void prune()
Removes all x-values for which all the y-values arenull.
-
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 aDatasetChangeEventto all registered listeners.- Specified by:
seriesChangedin interfaceSeriesChangeListener- Overrides:
seriesChangedin classAbstractSeriesDataset- Parameters:
event- information about the change.
-
equals
public boolean equals(java.lang.Object obj)
Tests this collection for equality with an arbitrary object.- Overrides:
equalsin classjava.lang.Object- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code.- Overrides:
hashCodein classjava.lang.Object- Returns:
- A hash code.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns an independent copy of this dataset.- Specified by:
clonein interfaceorg.jfree.util.PublicCloneable- Overrides:
clonein classAbstractDataset- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException- if there is some reason that cloning cannot be performed.
-
getDomainLowerBound
public double getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.- Specified by:
getDomainLowerBoundin interfaceDomainInfo- 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:
getDomainUpperBoundin interfaceDomainInfo- Parameters:
includeInterval- a flag that determines whether or not the x-interval is taken into account.- Returns:
- The maximum value.
-
getDomainBounds
public Range getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.- Specified by:
getDomainBoundsin interfaceDomainInfo- Parameters:
includeInterval- a flag that determines whether or not the x-interval is taken into account.- Returns:
- The range.
-
getIntervalPositionFactor
public double getIntervalPositionFactor()
Returns the interval position factor.- Returns:
- The interval position factor.
-
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.
-
getIntervalWidth
public double getIntervalWidth()
returns the full interval width.- Returns:
- The interval width to use.
-
setIntervalWidth
public void setIntervalWidth(double d)
Sets the interval width to a fixed value, and sends aDatasetChangeEventto all registered listeners.- Parameters:
d- the new interval width (must be > 0).
-
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.
-
setAutoWidth
public void setAutoWidth(boolean b)
Sets the flag that indicates whether the interval width is automatically calculated or not.- Parameters:
b- a boolean.
-
-