Module platform
Package org.jfree.data.xy

Class XYBarDataset

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.XYBarDataset
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, PublicCloneable, Dataset, DatasetChangeListener, SeriesChangeListener, SeriesDataset, IntervalXYDataset, 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.
See Also:

  • 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

    • 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

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

    • getSeriesCount

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

    • getSeriesKey

      public Comparable getSeriesKey(int series)
      Returns the key for a series.
      Specified by:
      getSeriesKey in interface SeriesDataset
      Specified by:
      getSeriesKey in class AbstractSeriesDataset
      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
      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
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The x-value.
      See Also:

    • 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 class AbstractXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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

      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 class AbstractXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

    • 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 class AbstractIntervalXYDataset
      Parameters:
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The value.
      See Also:

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