Package org.jfree.data.xy
Class XYBarDataset
- java.lang.Object
-
- All Implemented Interfaces:
java.io.ObjectInputValidation
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,PublicCloneable
,Dataset
,DatasetChangeListener
,SeriesChangeListener
,SeriesDataset
,IntervalXYDataset
,XYDataset
public class XYBarDataset extends AbstractIntervalXYDataset implements IntervalXYDataset, DatasetChangeListener, PublicCloneable
A dataset wrapper class that converts a standardXYDataset
into anIntervalXYDataset
suitable for use in creating XY bar charts.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private double
barWidth
The bar width.private XYDataset
underlying
The underlying dataset.
-
Constructor Summary
Constructors Constructor Description XYBarDataset(XYDataset underlying, double barWidth)
Creates a new dataset.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns an independent copy of the dataset.void
datasetChanged(DatasetChangeEvent event)
Receives notification of an dataset change event.boolean
equals(java.lang.Object obj)
Tests this dataset for equality with an arbitrary object.double
getBarWidth()
Returns the bar width.java.lang.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.java.lang.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.java.lang.Comparable
getSeriesKey(int series)
Returns the key for a series.java.lang.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.java.lang.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.java.lang.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.java.lang.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 aDatasetChangeEvent
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, canEqual, fireDatasetChanged, getGroup, getNotify, hashCode, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
-
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
-
Methods inherited from interface org.jfree.data.xy.XYDataset
getDomainOrder
-
-
-
-
Field Detail
-
underlying
private XYDataset underlying
The underlying dataset.
-
barWidth
private double barWidth
The bar width.
-
-
Constructor Detail
-
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 Detail
-
getUnderlyingDataset
public XYDataset 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 aDatasetChangeEvent
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 interfaceSeriesDataset
- Specified by:
getSeriesCount
in classAbstractSeriesDataset
- Returns:
- The series count.
-
getSeriesKey
public java.lang.Comparable getSeriesKey(int series)
Returns the key for a series.- Specified by:
getSeriesKey
in interfaceSeriesDataset
- Specified by:
getSeriesKey
in classAbstractSeriesDataset
- Parameters:
series
- the series index (in the range0
togetSeriesCount() - 1
).- Returns:
- The series key.
-
getItemCount
public int getItemCount(int series)
Returns the number of items in a series.- Specified by:
getItemCount
in interfaceXYDataset
- Parameters:
series
- the series index (zero-based).- Returns:
- The item count.
-
getX
public java.lang.Number getX(int series, int item)
Returns the x-value for an item within a series.- Specified by:
getX
in interfaceXYDataset
- 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 interfaceXYDataset
- Overrides:
getXValue
in classAbstractXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The value.
- See Also:
getX(int, int)
-
getY
public java.lang.Number getY(int series, int item)
Returns the y-value for an item within a series.- Specified by:
getY
in interfaceXYDataset
- 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 interfaceXYDataset
- Overrides:
getYValue
in classAbstractXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The value.
- See Also:
getY(int, int)
-
getStartX
public java.lang.Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.- Specified by:
getStartX
in interfaceIntervalXYDataset
- 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 interfaceIntervalXYDataset
- Overrides:
getStartXValue
in classAbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The value.
- See Also:
getXValue(int, int)
-
getEndX
public java.lang.Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.- Specified by:
getEndX
in interfaceIntervalXYDataset
- 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 interfaceIntervalXYDataset
- Overrides:
getEndXValue
in classAbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The value.
- See Also:
getXValue(int, int)
-
getStartY
public java.lang.Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.- Specified by:
getStartY
in interfaceIntervalXYDataset
- 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 interfaceIntervalXYDataset
- Overrides:
getStartYValue
in classAbstractIntervalXYDataset
- Parameters:
series
- the series index (zero-based).item
- the item index (zero-based).- Returns:
- The value.
- See Also:
getYValue(int, int)
-
getEndY
public java.lang.Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.- Specified by:
getEndY
in interfaceIntervalXYDataset
- 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 interfaceIntervalXYDataset
- Overrides:
getEndYValue
in classAbstractIntervalXYDataset
- 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 interfaceDatasetChangeListener
- Parameters:
event
- information about the event.
-
equals
public boolean equals(java.lang.Object obj)
Tests this dataset for equality with an arbitrary object.- Overrides:
equals
in classAbstractDataset
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
clone
public java.lang.Object clone() throws java.lang.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 interfacePublicCloneable
- Overrides:
clone
in classAbstractDataset
- Returns:
- An independent copy of the dataset.
- Throws:
java.lang.CloneNotSupportedException
- if the dataset cannot be cloned for any reason.
- the underlying dataset is only cloned if it implements the
-
-