Module org.jfree.chart

Package org.jfree.data.xy

Class CategoryTableXYDataset

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.general.AbstractSeriesDataset<S>

org.jfree.data.xy.AbstractXYDataset<S>

org.jfree.data.xy.AbstractIntervalXYDataset

org.jfree.data.xy.CategoryTableXYDataset

All Implemented Interfaces:

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

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CategoryTableXYDataset()	Creates a new empty CategoryTableXYDataset.

Method Summary

Modifier and Type	Method	Description
void	add(double x, double y, String seriesName)	Adds a data item to this dataset and sends a DatasetChangeEvent to all registered listeners.
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.
void	clear()	Clears all data from the dataset and sends a DatasetChangeEvent to all registered listeners.
Object	clone()	Returns an independent copy 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.
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()	Returns the number of x values in the dataset.
int	getItemCount(int series)	Returns the number of items in the specified 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 item)	Returns the y-value for the specified series and item.
boolean	isAutoWidth()	Returns whether the interval width is automatically calculated or not.
void	remove(double x, String seriesName)	Removes a value from the dataset.
void	remove(Number x, String seriesName, boolean notify)	Removes an item from the dataset.
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.

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, seriesChanged

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

addChangeListener, fireDatasetChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotify, validateObject

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, removeChangeListener

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

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?

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?

clear

public void clear()

Clears all data from the dataset and sends a DatasetChangeEvent to all registered listeners.

Since:

1.0.14

getSeriesCount

public int getSeriesCount()

Returns the number of series in the collection.

Specified by:

getSeriesCount in interface SeriesDataset

Specified by:

getSeriesCount in class AbstractSeriesDataset

Returns:

The series count.

getSeriesKey

public Comparable<?> getSeriesKey(int series)

Returns the key for a series.

Specified by:

getSeriesKey in interface SeriesDataset

Specified by:

getSeriesKey in class AbstractSeriesDataset

Parameters:

series - the series index (zero-based).

Returns:

The key for a series.

getItemCount

public int getItemCount()

Returns the number of x values in the dataset.

Specified by:

getItemCount in interface TableXYDataset

Returns:

The item count.

getItemCount

public int getItemCount(int series)

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

Specified by:

getItemCount in interface XYDataset

Parameters:

series - the series index (zero-based).

Returns:

The item count.

getX

public Number getX(int series,
                   int item)

Returns the x-value for the specified series and item.

Specified by:

getX in interface XYDataset

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The value.

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

item - the item index (zero-based).

Returns:

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

item - the item index (zero-based).

Returns:

The ending X value.

getY

public Number getY(int series,
                   int item)

Returns the y-value for the specified series and item.

Specified by:

getY in interface XYDataset

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The y value (possibly null).

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

item - the item index (zero-based).

Returns:

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

item - the item index (zero-based).

Returns:

The ending Y value.

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.

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 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 a DatasetChangeEvent to 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:

whether the width is automatically calculated or not.

setAutoWidth

public void setAutoWidth(boolean b)

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

Parameters:

b - the flag.

equals

public boolean equals(Object obj)

Tests this dataset for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns an independent copy of this dataset.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDataset

Returns:

A clone.

Throws:

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