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 XYBarDataset

Implemented Interfaces:
Cloneable, Dataset, DatasetChangeListener, EventListener, IntervalXYDataset, ObjectInputValidation, PublicCloneable, Serializable, SeriesChangeListener, SeriesDataset, XYDataset
public class XYBarDataset
extends AbstractIntervalXYDataset
implements IntervalXYDataset, DatasetChangeListener, PublicCloneable
A dataset wrapper class that converts a standard XYDataset into an IntervalXYDataset suitable for use in creating XY bar charts.

Constructor Summary

XYBarDataset(XYDataset underlying, double barWidth)
Creates a new dataset.

Method Summary

Object
clone()
Returns an independent copy of the dataset.
void
datasetChanged(DatasetChangeEvent event)
Receives notification of an dataset change event.
boolean
equals(Object obj)
Tests this dataset for equality with an arbitrary object.
double
getBarWidth()
Returns the bar width.
Number
getEndX(int series, int item)
Returns the ending X value for the specified series and item.
double
getEndXValue(int series, int item)
Returns the ending x-value (as a double primitive) for an item within a series.
Number
getEndY(int series, int item)
Returns the ending Y value for the specified series and item.
double
getEndYValue(int series, int item)
Returns the ending y-value (as a double primitive) for an item within a series.
int
getItemCount(int series)
Returns the number of items in a series.
int
getSeriesCount()
Returns the number of series in the dataset.
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.
double
getStartXValue(int series, int item)
Returns the starting x-value (as a double primitive) for an item within a series.
Number
getStartY(int series, int item)
Returns the starting Y value for the specified series and item.
double
getStartYValue(int series, int item)
Returns the starting y-value (as a double primitive) for an item within a series.
XYDataset
getUnderlyingDataset()
Returns the underlying dataset that was specified via the constructor.
Number
getX(int series, int item)
Returns the x-value for an item within a series.
double
getXValue(int series, int item)
Returns the x-value (as a double primitive) for an item within a series.
Number
getY(int series, int item)
Returns the y-value for an item within a series.
double
getYValue(int series, int item)
Returns the y-value (as a double primitive) for an item within a series.
void
setBarWidth(double barWidth)
Sets the bar width 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

XYBarDataset

public XYBarDataset(XYDataset underlying,
                    double barWidth)
Creates a new dataset.
Parameters:
underlying - the underlying dataset (null not permitted).
barWidth - the width of the bars.

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns an independent copy of the dataset. Note that:
  • the underlying dataset is only cloned if it implements the PublicCloneable interface;
  • the listeners registered with this dataset are not carried over to the cloned dataset.
Overrides:
clone in interface AbstractDataset
Returns:
An independent copy of the dataset.

datasetChanged

public void datasetChanged(DatasetChangeEvent event)
Receives notification of an dataset change event.
Specified by:
datasetChanged in interface DatasetChangeListener
Parameters:
event - information about the event.

equals

public boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getBarWidth

public double getBarWidth()
Returns the bar width.
Returns:
The bar width.
Since:
1.0.4
See Also:
setBarWidth(double)

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

getEndXValue

public double getEndXValue(int series,
                           int item)
Returns the ending x-value (as a double primitive) for an item within a series.
Specified by:
getEndXValue in interface IntervalXYDataset
Overrides:
getEndXValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getXValue(int,int)

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

getEndYValue

public double getEndYValue(int series,
                           int item)
Returns the ending y-value (as a double primitive) for an item within a series.
Specified by:
getEndYValue in interface IntervalXYDataset
Overrides:
getEndYValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getYValue(int,int)

getItemCount

public int getItemCount(int series)
Returns the number of items in a series.
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 dataset.
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 (in the range 0 to getSeriesCount() - 1).
Returns:
The series key.

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

getStartXValue

public double getStartXValue(int series,
                             int item)
Returns the starting x-value (as a double primitive) for an item within a series.
Specified by:
getStartXValue in interface IntervalXYDataset
Overrides:
getStartXValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getXValue(int,int)

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

getStartYValue

public double getStartYValue(int series,
                             int item)
Returns the starting y-value (as a double primitive) for an item within a series.
Specified by:
getStartYValue in interface IntervalXYDataset
Overrides:
getStartYValue in interface AbstractIntervalXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getYValue(int,int)

getUnderlyingDataset

public XYDataset getUnderlyingDataset()
Returns the underlying dataset that was specified via the constructor.
Returns:
The underlying dataset (never null).
Since:
1.0.4

getX

public Number getX(int series,
                   int item)
Returns the x-value for an item within a series.
Specified by:
getX in interface XYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The x-value.
See Also:
getXValue(int,int)

getXValue

public double getXValue(int series,
                        int item)
Returns the x-value (as a double primitive) for an item within a series.
Specified by:
getXValue in interface XYDataset
Overrides:
getXValue in interface AbstractXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getX(int,int)

getY

public Number getY(int series,
                   int item)
Returns the y-value for an item within a series.
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).
See Also:
getYValue(int,int)

getYValue

public double getYValue(int series,
                        int item)
Returns the y-value (as a double primitive) for an item within a series.
Specified by:
getYValue in interface XYDataset
Overrides:
getYValue in interface AbstractXYDataset
Parameters:
series - the series index (zero-based).
item - the item index (zero-based).
Returns:
The value.
See Also:
getY(int,int)

setBarWidth

public void setBarWidth(double barWidth)
Sets the bar width and sends a DatasetChangeEvent to all registered listeners.
Parameters:
barWidth - the bar width.
Since:
1.0.4
See Also:
getBarWidth()

Overview Package Class Use Source Tree Index Deprecated About