Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.data.category

Class DefaultIntervalCategoryDataset

Implemented Interfaces:
CategoryDataset, Cloneable, Dataset, EventListener, IntervalCategoryDataset, KeyedValues2D, ObjectInputValidation, Serializable, 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.

Constructor Summary

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.
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(double[][] starts, double[][] ends)
Creates a new dataset.

Method Summary

Object
clone()
Returns a clone of this dataset.
boolean
equals(Object obj)
Tests this dataset for equality with an arbitrary object.
List
getCategories()
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(Comparable series, Comparable category)
Returns the end data value for one category in a series.
Number
getEndValue(int series, int category)
Returns the end data value for one category in a series.
int
getItemCount()
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()
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(Comparable series, Comparable category)
Returns the data value for one category in a series.
Number
getValue(int series, int 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.

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

getSeriesCount, getSeriesKey, indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, clone, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Constructor Details

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

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.
starts - the start values data, indexed as data[series][category].
ends - the end values data, indexed as data[series][category].

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.

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this dataset.
Overrides:
clone in interface AbstractDataset
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getCategories

public List getCategories()

Deprecated. Use getColumnKeys() instead.

Returns a list of the categories in the dataset.
Returns:
A list of the categories in the dataset.

getCategoryCount

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

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:
getColumnIndex(Comparable)

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:
getCategoryCount(), getRowCount()

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:
getCategoryIndex(Comparable)

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:
getRowKey(int)

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:
getRowKeys()

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(int,int)

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:
getEndValue(Comparable,Comparable)

getItemCount

public int getItemCount()

Deprecated. Use getCategoryCount() instead.

Returns the item count.
Returns:
The item count.

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:
getSeriesCount(), getColumnCount()

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:
getSeriesIndex(Comparable)

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:
getColumnKey(int)

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:
getColumnKeys()

getSeries

public List getSeries()

Deprecated. Use getRowKeys() instead.

Returns a list of the series in the dataset.
Returns:
A list of the series in the dataset.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the dataset (possibly zero).
Specified by:
getSeriesCount in interface SeriesDataset
Overrides:
getSeriesCount in interface AbstractSeriesDataset
Returns:
The number of series in the dataset.
See Also:
getRowCount(), getCategoryCount()

getSeriesIndex

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

getSeriesKey

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

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(int,int)

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:
getStartValue(Comparable,Comparable)

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:
getEndValue(Comparable,Comparable)

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:
getEndValue(int,int)

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:
getRowKeys(), setSeriesKeys(Comparable[])

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:
setStartValue(int,Comparable,Number)

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:
setCategoryKeys(Comparable[])

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(int,Comparable,Number)

Overview Package Class Use Source Tree Index Deprecated About