Module platform
Package org.jfree.data.category

Class DefaultIntervalCategoryDataset

java.lang.Object
org.jfree.data.general.AbstractDataset
org.jfree.data.general.AbstractSeriesDataset
org.jfree.data.category.DefaultIntervalCategoryDataset
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, CategoryDataset, IntervalCategoryDataset, Dataset, SeriesChangeListener, SeriesDataset, KeyedValues2D, 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.

See Also:

  • Constructor Details

    • DefaultIntervalCategoryDataset

      public DefaultIntervalCategoryDataset(double[][] starts, double[][] ends)
      Creates a new dataset using the specified data values and automatically generated series and category keys.
      Parameters:
      starts - the starting values for the intervals (null not permitted).
      ends - the ending values for the intervals (null not permitted).

    • 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 setSeriesKeys(Comparable[]) and setCategoryKeys(Comparable[]) 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 (if null, series names will be generated automatically).
      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 (if null, series keys will be generated automatically).
      categoryKeys - the category keys (if null, category keys will be generated automatically).
      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.
      See Also:

    • getSeriesIndex

      public int getSeriesIndex(Comparable seriesKey)
      Returns a series index.
      Parameters:
      seriesKey - the series key.
      Returns:
      The series index.
      See Also:

    • getSeriesKey

      public Comparable getSeriesKey(int series)
      Returns the name of the specified series.
      Specified by:
      getSeriesKey in interface SeriesDataset
      Specified by:
      getSeriesKey in class AbstractSeriesDataset
      Parameters:
      series - the index of the required series (zero-based).
      Returns:
      The name of the specified series.
      See Also:

    • setSeriesKeys

      public void setSeriesKeys(Comparable[] seriesKeys)
      Sets the names of the series in the dataset.
      Parameters:
      seriesKeys - the new keys (null not permitted, the length of the array must match the number of series in the dataset).
      See Also:

    • getCategoryCount

      public int getCategoryCount()
      Returns the number of categories in the dataset.
      Returns:
      The number of categories in the dataset.
      See Also:

    • getColumnKeys

      public List getColumnKeys()
      Returns a list of the categories in the dataset. This method supports the CategoryDataset interface.
      Specified by:
      getColumnKeys in interface KeyedValues2D
      Returns:
      A list of the categories in the dataset.
      See Also:

    • setCategoryKeys

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

    • 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).
      See Also:

    • 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).
      See Also:

    • getStartValue

      public Number getStartValue(Comparable series, Comparable category)
      Returns the start data value for one category in a series.
      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 (possibly null).
      See Also:

    • getStartValue

      public Number getStartValue(int series, int category)
      Returns the start data value for one category in a series.
      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 (possibly null).
      See Also:

    • getEndValue

      public Number getEndValue(Comparable series, Comparable category)
      Returns the end data value for one category in a series.
      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).
      See Also:

    • getEndValue

      public Number getEndValue(int series, int category)
      Returns the end data value for one category in a series.
      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).
      See Also:

    • setStartValue

      public void setStartValue(int series, Comparable 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.
      See Also:

    • setEndValue

      public void setEndValue(int series, Comparable 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.
      See Also:

    • getCategoryIndex

      public int getCategoryIndex(Comparable category)
      Returns the index for the given category.
      Parameters:
      category - the category (null not permitted).
      Returns:
      The index.
      See Also:

    • getColumnKey

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

    • getColumnIndex

      public int getColumnIndex(Comparable columnKey)
      Returns a column index.
      Specified by:
      getColumnIndex in interface KeyedValues2D
      Parameters:
      columnKey - the column key (null not permitted).
      Returns:
      The column index.
      See Also:

    • 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.
      See Also:

    • getRowKeys

      public List getRowKeys()
      Returns a list of the series in the dataset. This method supports the CategoryDataset interface.
      Specified by:
      getRowKeys in interface KeyedValues2D
      Returns:
      A list of the series in the dataset.
      See Also:

    • getRowKey

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

    • 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.
      See Also:

    • 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.
      See Also:

    • 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 a clone of this dataset.
      Overrides:
      clone in class AbstractDataset
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem cloning the dataset.