Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.xy

Class CategoryTableXYDataset

Implemented Interfaces:
Cloneable, Dataset, DomainInfo, EventListener, IntervalXYDataset, ObjectInputValidation, Serializable, SeriesChangeListener, SeriesDataset, TableXYDataset, XYDataset
public class CategoryTableXYDataset
extends AbstractIntervalXYDataset
implements TableXYDataset, IntervalXYDataset, DomainInfo
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

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
add(double x, double y, String seriesName)
Adds a data item to this dataset and sends a DatasetChangeEvent to all registered listeners.
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(Number x, String seriesName, boolean notify)
Removes an item from the dataset.
void
remove(double x, String seriesName)
Removes a value 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

getSeriesCount, getSeriesKey, indexOf, seriesChanged

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

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

CategoryTableXYDataset

public CategoryTableXYDataset()
Creates a new empty CategoryTableXYDataset.

Method Details

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?

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.

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

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.

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.

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.

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

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.
Specified by:
getSeriesKey in interface SeriesDataset
Overrides:
getSeriesKey in interface AbstractSeriesDataset
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.
Specified by:
getStartX in interface IntervalXYDataset
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.
Specified by:
getStartY in interface IntervalXYDataset
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.
Specified by:
getX in interface XYDataset
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.
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).

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(Number x,
                   String seriesName,
                   boolean notify)
Removes an item from the dataset.
Parameters:
x - the x-value.
seriesName - the series name.
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.

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

Overview Package Class Use Source Tree Index Deprecated About