Module org.jfree.chart

Package org.jfree.data.xy

Class XYBarDataset<S extends Comparable<S>>

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

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

All Implemented Interfaces:

ObjectInputValidation, Serializable, Cloneable, EventListener, PublicCloneable, Dataset, DatasetChangeListener, SeriesChangeListener, SeriesDataset<S>, IntervalXYDataset<S>, XYDataset<S>

public class XYBarDataset<S extends Comparable<S>>
extends AbstractIntervalXYDataset<S>
implements IntervalXYDataset<S>, DatasetChangeListener, PublicCloneable

A dataset wrapper class that converts a standard XYDataset into an IntervalXYDataset suitable for use in creating XY bar charts.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XYBarDataset(XYDataset<S> underlying, double barWidth)	Creates a new dataset.

Method Summary

Modifier and Type	Method	Description
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.
S	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<S>	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.AbstractXYDataset

getDomainOrder

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

indexOf

Methods inherited from interface org.jfree.data.xy.XYDataset

getDomainOrder

Constructor Detail

XYBarDataset

public XYBarDataset(XYDataset<S> underlying,
                    double barWidth)

Creates a new dataset.

Parameters:

underlying - the underlying dataset (null not permitted).

barWidth - the width of the bars.

Method Detail

getUnderlyingDataset

public XYDataset<S> getUnderlyingDataset()

Returns the underlying dataset that was specified via the constructor.

Returns:

The underlying dataset (never null).

getBarWidth

public double getBarWidth()

Returns the bar width.

Returns:

The bar width.

See Also:

setBarWidth(double)

setBarWidth

public void setBarWidth(double barWidth)

Sets the bar width and sends a DatasetChangeEvent to all registered listeners.

Parameters:

barWidth - the bar width.

See Also:

getBarWidth()

getSeriesCount

public int getSeriesCount()

Returns the number of series in the dataset.

Specified by:

getSeriesCount in interface SeriesDataset<S extends Comparable<S>>

Specified by:

getSeriesCount in class AbstractSeriesDataset<S extends Comparable<S>>

Returns:

The series count.

getSeriesKey

public S getSeriesKey(int series)

Returns the key for a series.

Specified by:

getSeriesKey in interface SeriesDataset<S extends Comparable<S>>

Specified by:

getSeriesKey in class AbstractSeriesDataset<S extends Comparable<S>>

Parameters:

series - the series index (in the range 0 to getSeriesCount() - 1).

Returns:

The series key.

getItemCount

public int getItemCount(int series)

Returns the number of items in a series.

Specified by:

getItemCount in interface XYDataset<S extends Comparable<S>>

Parameters:

series - the series index (zero-based).

Returns:

The item count.

getX

public Number getX(int series,
                   int item)

Returns the x-value for an item within a series.

Specified by:

getX in interface XYDataset<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getXValue in class AbstractXYDataset<S extends Comparable<S>>

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<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getYValue in class AbstractXYDataset<S extends Comparable<S>>

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The value.

See Also:

getY(int, int)

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<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getStartXValue in class AbstractIntervalXYDataset<S extends Comparable<S>>

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The value.

See Also:

getXValue(int, int)

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<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getEndXValue in class AbstractIntervalXYDataset<S extends Comparable<S>>

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<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getStartYValue in class AbstractIntervalXYDataset<S extends Comparable<S>>

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The value.

See Also:

getYValue(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<S extends Comparable<S>>

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<S extends Comparable<S>>

Overrides:

getEndYValue in class AbstractIntervalXYDataset<S extends Comparable<S>>

Parameters:

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

The value.

See Also:

getYValue(int, int)

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.

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

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDataset

Returns:

An independent copy of the dataset.

Throws:

CloneNotSupportedException - if the dataset cannot be cloned for any reason.