org.jfree.data.xy

Class CategoryTableXYDataset

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

An implementation variant of the TableXYDataset where every series shares the same x-values (required for generating stacked area charts). This implementation uses a DefaultKeyedValues2D Object as backend implementation and is hence more "category oriented" than the DefaultTableXYDataset implementation.

This implementation provides no means to remove data items yet. This is due to the lack of such facility in the DefaultKeyedValues2D class.

This class also implements the IntervalXYDataset interface, but this implementation is provisional.

Constructor Summary
CategoryTableXYDataset()
Creates a new empty CategoryTableXYDataset.
Method Summary
voidadd(double x, double y, String seriesName)
Adds a data item to this dataset and sends a DatasetChangeEvent to all registered listeners.
voidadd(Number x, Number y, String seriesName, boolean notify)
Adds a data item to this dataset and, if requested, sends a DatasetChangeEvent to all registered listeners.
Objectclone()
Returns an independent copy 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.
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.
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 item)
Returns the y-value for the specified series and item.
booleanisAutoWidth()
Returns whether the interval width is automatically calculated or not.
voidremove(double x, String seriesName)
Removes a value from the dataset.
voidremove(Number x, String seriesName, boolean notify)
Removes an item from the dataset.
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.

Constructor Detail

CategoryTableXYDataset

public CategoryTableXYDataset()
Creates a new empty CategoryTableXYDataset.

Method Detail

add

public void add(double x, double y, String seriesName)
Adds a data item to this dataset and sends a DatasetChangeEvent to all registered listeners.

Parameters: x the x value. y the y value. seriesName the name of the series to add the data item.

add

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

Parameters: x the x value. y the y value. seriesName the name of the series to add the data item. notify notify listeners?

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

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

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 item count.

getItemCount

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

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

Returns: The item count.

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

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

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

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 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 the specified series and item.

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

Returns: The y value (possibly null).

isAutoWidth

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

Returns: whether the width is automatically calculated or not.

remove

public void remove(double x, String seriesName)
Removes a value from the dataset.

Parameters: x the x-value. seriesName the series name.

remove

public void remove(Number x, String seriesName, boolean notify)
Removes an item from the dataset.

Parameters: x the x-value. seriesName the series name. notify notify listeners?

setAutoWidth

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

Parameters: b the flag.

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