public class

DefaultIntervalCategoryDataset

extends AbstractSeriesDataset
implements IntervalCategoryDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.category.DefaultIntervalCategoryDataset

Class Overview

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.

Summary

Public Constructors
DefaultIntervalCategoryDataset(double[][] starts, double[][] ends)
Creates a new dataset using the specified data values and automatically generated series and category keys.
DefaultIntervalCategoryDataset(Number[][] starts, Number[][] ends)
Constructs a dataset and populates it with data from the array.
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.
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.
Public Methods
Object clone()
Returns a clone of this dataset.
boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
List getCategories()
This method is deprecated. Use getColumnKeys() instead.
int getCategoryCount()
Returns the number of categories in the dataset.
int getCategoryIndex(Comparable category)
Returns the index for the given category.
int getColumnCount()
Returns the number of categories in the dataset.
int getColumnIndex(Comparable columnKey)
Returns a column index.
Comparable getColumnKey(int column)
Returns a column key.
List getColumnKeys()
Returns a list of the categories in the dataset.
Number getEndValue(int series, int category)
Returns the end data value for one category in a series.
Number getEndValue(Comparable series, Comparable category)
Returns the end data value for one category in a series.
int getItemCount()
This method is deprecated. Use getCategoryCount() instead.
int getRowCount()
Returns the number of series in the dataset (possibly zero).
int getRowIndex(Comparable rowKey)
Returns a row index.
Comparable getRowKey(int row)
Returns the name of the specified series.
List getRowKeys()
Returns a list of the series in the dataset.
List getSeries()
This method is deprecated. Use getRowKeys() instead.
int getSeriesCount()
Returns the number of series in the dataset (possibly zero).
int getSeriesIndex(Comparable seriesKey)
Returns a series index.
Comparable getSeriesKey(int series)
Returns the name of the specified series.
Number getStartValue(Comparable series, Comparable category)
Returns the start data value for one category in a series.
Number getStartValue(int series, int category)
Returns the start data value for one category in a series.
Number getValue(int series, int category)
Returns the data value for one category in a series.
Number getValue(Comparable series, Comparable category)
Returns the data value for one category in a series.
void setCategoryKeys(Comparable[] categoryKeys)
Sets the categories for the dataset.
void setEndValue(int series, Comparable category, Number value)
Sets the end data value for one category in a series.
void setSeriesKeys(Comparable[] seriesKeys)
Sets the names of the series in the dataset.
void setStartValue(int series, Comparable category, Number value)
Sets the start data value for one category in a series.
[Expand]
Inherited Methods
From class org.jfree.data.general.AbstractSeriesDataset
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.KeyedValues2D
From interface org.jfree.data.Values2D
From interface org.jfree.data.category.IntervalCategoryDataset
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.SeriesChangeListener
From interface org.jfree.data.general.SeriesDataset

Public Constructors

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

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.

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

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

Public Methods

public Object clone ()

Returns a clone of this dataset.

Returns
  • A clone.
Throws
CloneNotSupportedException if there is a problem cloning the dataset.

public boolean equals (Object obj)

Tests this dataset for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public List getCategories ()

This method is deprecated.
Use getColumnKeys() instead.

Returns a list of the categories in the dataset.

Returns
  • A list of the categories in the dataset.

public int getCategoryCount ()

Returns the number of categories in the dataset.

Returns
  • The number of categories in the dataset.
See Also

public int getCategoryIndex (Comparable category)

Returns the index for the given category.

Parameters
category the category (null not permitted).
Returns
  • The index.
See Also

public int getColumnCount ()

Returns the number of categories in the dataset. This method is part of the CategoryDataset interface.

Returns
  • The number of categories in the dataset.
See Also

public int getColumnIndex (Comparable columnKey)

Returns a column index.

Parameters
columnKey the column key (null not permitted).
Returns
  • The column index.
See Also

public Comparable getColumnKey (int column)

Returns a column key.

Parameters
column the column index.
Returns
  • The column key.
See Also

public List getColumnKeys ()

Returns a list of the categories in the dataset. This method supports the CategoryDataset interface.

Returns
  • A list of the categories in the dataset.
See Also

public Number getEndValue (int series, int category)

Returns the end data value for one category in a series.

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

public Number getEndValue (Comparable series, Comparable category)

Returns the end data value for one category in a series.

Parameters
series the required series.
category the required category.
Returns
  • The end data value for one category in a series (null possible).
See Also

public int getItemCount ()

This method is deprecated.
Use getCategoryCount() instead.

Returns the item count.

Returns
  • The item count.

public int getRowCount ()

Returns the number of series in the dataset (possibly zero).

Returns
  • The number of series in the dataset.
See Also

public int getRowIndex (Comparable rowKey)

Returns a row index.

Parameters
rowKey the row key.
Returns
  • The row index.
See Also

public Comparable getRowKey (int row)

Returns the name of the specified series.

Parameters
row the index of the required row/series (zero-based).
Returns
  • The name of the specified series.
See Also

public List getRowKeys ()

Returns a list of the series in the dataset. This method supports the CategoryDataset interface.

Returns
  • A list of the series in the dataset.
See Also

public List getSeries ()

This method is deprecated.
Use getRowKeys() instead.

Returns a list of the series in the dataset.

Returns
  • A list of the series in the dataset.

public int getSeriesCount ()

Returns the number of series in the dataset (possibly zero).

Returns
  • The number of series in the dataset.
See Also

public int getSeriesIndex (Comparable seriesKey)

Returns a series index.

Parameters
seriesKey the series key.
Returns
  • The series index.
See Also

public Comparable getSeriesKey (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.
See Also

public Number getStartValue (Comparable series, Comparable category)

Returns the start data value for one category in a series.

Parameters
series the required series.
category the required category.
Returns
  • The start data value for one category in a series (possibly null).
See Also

public Number getStartValue (int series, int category)

Returns the start data value for one category in a series.

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

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.

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

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.

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

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

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

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

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