Package org.jfree.data

Class DefaultIntervalCategoryDataset

java.lang.Object
org.jfree.data.AbstractDataset
org.jfree.data.AbstractSeriesDataset
org.jfree.data.DefaultIntervalCategoryDataset
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, CategoryDataset, Dataset, IntervalCategoryDataset, KeyedValues2D, SeriesChangeListener, SeriesDataset, Values2D
public class DefaultIntervalCategoryDataset
extends AbstractSeriesDataset
implements IntervalCategoryDataset
A convenience class that provides a default implementation of the IntervalCategoryDataset interface.

The standard constructor accepts data in a two dimensional array where the first dimension is the series, and the second dimension is the category.

Author:
Jeremy Bowman
See Also:
Serialized Form

  • Constructor Details

    • DefaultIntervalCategoryDataset

      public DefaultIntervalCategoryDataset​(double[][] starts, double[][] ends)
      Creates a new dataset.
      Parameters:
      starts - the starting values for the intervals.
      ends - the ending values for the intervals.

    • DefaultIntervalCategoryDataset

      public DefaultIntervalCategoryDataset​(Number[][] starts, Number[][] ends)
      Constructs a dataset and populates it with data from the array.

      The arrays are indexed as data[series][category]. Series and category names are automatically generated - you can change them using the setSeriesName(...) and setCategory(...) methods.

      Parameters:
      starts - the start values data.
      ends - the end values data.

    • DefaultIntervalCategoryDataset

      public DefaultIntervalCategoryDataset​(String[] seriesNames, Number[][] starts, Number[][] ends)
      Constructs a DefaultIntervalCategoryDataset, populates it with data from the arrays, and uses the supplied names for the series.

      Category names are generated automatically ("Category 1", "Category 2", etc).

      Parameters:
      seriesNames - the series names.
      starts - the start values data, indexed as data[series][category].
      ends - the end values data, indexed as data[series][category].

    • DefaultIntervalCategoryDataset

      public DefaultIntervalCategoryDataset​(Comparable[] seriesKeys, Comparable[] categoryKeys, Number[][] starts, Number[][] ends)
      Constructs a DefaultIntervalCategoryDataset, populates it with data from the arrays, and uses the supplied names for the series and the supplied objects for the categories.
      Parameters:
      seriesKeys - the series keys.
      categoryKeys - the categories.
      starts - the start values data, indexed as data[series][category].
      ends - the end values data, indexed as data[series][category].

  • Method Details

    • getSeriesCount

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

    • getItemCount

      public int getItemCount()
      Returns the item count.
      Returns:
      The item count.

    • getCategory

      public Comparable getCategory​(int item)
      Returns a category key.
      Parameters:
      item - the category index.
      Returns:
      The category key.

    • getItem

      public int getItem​(Object category)
      Returns an item.
      Parameters:
      category - the category key.
      Returns:
      The item index.

    • getSeriesIndex

      public int getSeriesIndex​(Object series)
      Returns a series index.
      Parameters:
      series - the series.
      Returns:
      The series index.

    • getSeries

      public Comparable getSeries​(int series)
      Returns the name of the specified series.
      Parameters:
      series - the index of the required series (zero-based).
      Returns:
      the name of the specified series.

    • getSeriesName

      public String getSeriesName​(int series)
      Returns the name of the specified series.
      Specified by:
      getSeriesName in interface SeriesDataset
      Specified by:
      getSeriesName in class AbstractSeriesDataset
      Parameters:
      series - The index of the required series (zero-based).
      Returns:
      the name of the specified series.

    • setSeriesKeys

      public void setSeriesKeys​(Comparable[] seriesKeys)
      Sets the names of the series in the dataset.
      Parameters:
      seriesKeys - the keys of the series in the dataset.

    • getCategoryCount

      public int getCategoryCount()
      Returns the number of categories in the dataset.

      This method is part of the CategoryDataset interface.

      Returns:
      the number of categories in the dataset.

    • getSeries

      public List getSeries()
      Returns a list of the series in the dataset.

      Supports the CategoryDataset interface.

      Returns:
      a list of the series in the dataset.

    • getCategories

      public List getCategories()
      Returns a list of the categories in the dataset.

      Supports the CategoryDataset interface.

      Returns:
      a list of the categories in the dataset.

    • getColumnKeys

      public List getColumnKeys()
      Returns a list of the categories in the dataset.

      Supports the CategoryDataset interface.

      Specified by:
      getColumnKeys in interface KeyedValues2D
      Returns:
      a list of the categories in the dataset.

    • setCategoryKeys

      public void setCategoryKeys​(Comparable[] categoryKeys)
      Sets the categories for the dataset.
      Parameters:
      categoryKeys - An array of objects representing the categories in the dataset.

    • getValue

      public Number getValue​(Comparable series, Comparable category)
      Returns the data value for one category in a series.

      This method is part of the CategoryDataset interface. Not particularly meaningful for this class...returns the end value.

      Specified by:
      getValue in interface KeyedValues2D
      Parameters:
      series - The required series (zero based index).
      category - The required category.
      Returns:
      The data value for one category in a series (null possible).

    • getValue

      public Number getValue​(int series, int category)
      Returns the data value for one category in a series.

      This method is part of the CategoryDataset interface. Not particularly meaningful for this class...returns the end value.

      Specified by:
      getValue in interface Values2D
      Parameters:
      series - The required series (zero based index).
      category - The required category.
      Returns:
      The data value for one category in a series (null possible).

    • getStartValue

      public Number getStartValue​(Comparable series, Comparable category)
      Returns the start data value for one category in a series.

      This method is part of the IntervalTableDataset interface.

      Specified by:
      getStartValue in interface IntervalCategoryDataset
      Parameters:
      series - The required series.
      category - The required category.
      Returns:
      The start data value for one category in a series (null possible).

    • getStartValue

      public Number getStartValue​(int series, int category)
      Returns the start data value for one category in a series.

      This method is part of the IntervalTableDataset interface.

      Specified by:
      getStartValue in interface IntervalCategoryDataset
      Parameters:
      series - The required series (zero based index).
      category - The required category.
      Returns:
      The start data value for one category in a series (null possible).

    • getEndValue

      public Number getEndValue​(Comparable series, Comparable category)
      Returns the end data value for one category in a series.

      This method is part of the IntervalTableDataset interface.

      Specified by:
      getEndValue in interface IntervalCategoryDataset
      Parameters:
      series - the required series.
      category - the required category.
      Returns:
      the end data value for one category in a series (null possible).

    • getEndValue

      public Number getEndValue​(int series, int category)
      Returns the end data value for one category in a series.

      This method is part of the IntervalTableDataset interface.

      Specified by:
      getEndValue in interface IntervalCategoryDataset
      Parameters:
      series - the required series (zero based index).
      category - the required category.
      Returns:
      the end data value for one category in a series (null possible).

    • setStartValue

      public void setStartValue​(int series, Object category, Number value)
      Sets the start data value for one category in a series.
      Parameters:
      series - The series (zero-based index).
      category - The category.
      value - The value.

    • setEndValue

      public void setEndValue​(int series, Object category, Number value)
      Sets the end data value for one category in a series.
      Parameters:
      series - the series (zero-based index).
      category - the category.
      value - the value.

    • getColumnKey

      public Comparable getColumnKey​(int item)
      Returns a column key.
      Specified by:
      getColumnKey in interface KeyedValues2D
      Parameters:
      item - the column index.
      Returns:
      The column key.

    • getColumnIndex

      public int getColumnIndex​(Comparable columnKey)
      Returns a column index.
      Specified by:
      getColumnIndex in interface KeyedValues2D
      Parameters:
      columnKey - the column key.
      Returns:
      The column index.

    • getRowIndex

      public int getRowIndex​(Comparable rowKey)
      Returns a row index.
      Specified by:
      getRowIndex in interface KeyedValues2D
      Parameters:
      rowKey - the row key.
      Returns:
      The row index.

    • getRowKeys

      public List getRowKeys()
      Returns a list of the series in the dataset.

      Supports the CategoryDataset interface.

      Specified by:
      getRowKeys in interface KeyedValues2D
      Returns:
      a list of the series in the dataset.

    • getRowKey

      public Comparable getRowKey​(int series)
      Returns the name of the specified series.
      Specified by:
      getRowKey in interface KeyedValues2D
      Parameters:
      series - the index of the required series (zero-based).
      Returns:
      the name of the specified series.

    • getColumnCount

      public int getColumnCount()
      Returns the number of categories in the dataset.

      This method is part of the CategoryDataset interface.

      Specified by:
      getColumnCount in interface Values2D
      Returns:
      the number of categories in the dataset.

    • getRowCount

      public int getRowCount()
      Returns the number of series in the dataset (possibly zero).
      Specified by:
      getRowCount in interface Values2D
      Returns:
      the number of series in the dataset.