Use Tree Navigation
public class

CategoryTableXYDataset

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

Class Overview

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.

Summary

Public Constructors
CategoryTableXYDataset()
Creates a new empty CategoryTableXYDataset.
Public Methods
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.
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(int series)
Returns the number of items in the specified series.
int getItemCount()
Returns the number of x values in the dataset.
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.
[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 CategoryTableXYDataset ()

Creates a new empty CategoryTableXYDataset.

Public Methods

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?

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.

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 dataset 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 index (zero-based).
item the item index (zero-based).
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 index (zero-based).
item the item index (zero-based).
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. Returns the same as getItemCount().

Parameters
series the series index (zero-based).
Returns
  • The item count.

public int getItemCount ()

Returns the number of x values in the dataset.

Returns
  • The item count.

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

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

public boolean isAutoWidth ()

Returns whether the interval width is automatically calculated or not.

Returns
  • whether the width is automatically calculated or not.

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?

public void remove (double x, String seriesName)

Removes a value from the dataset.

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

public void setAutoWidth (boolean b)

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

Parameters
b the flag.

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