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

Class TaskSeriesCollection

Implemented Interfaces:
CategoryDataset, Cloneable, Dataset, EventListener, GanttCategoryDataset, IntervalCategoryDataset, KeyedValues2D, ObjectInputValidation, PublicCloneable, Serializable, SeriesChangeListener, SeriesDataset, Values2D
public class TaskSeriesCollection
extends AbstractSeriesDataset
implements GanttCategoryDataset, Cloneable, PublicCloneable, Serializable
A collection of TaskSeries objects. This class provides one implementation of the GanttCategoryDataset interface.

Constructor Summary

TaskSeriesCollection()
Default constructor.

Method Summary

void
add(TaskSeries series)
Adds a series to the dataset and sends a DatasetChangeEvent to all registered listeners.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
int
getColumnCount()
Returns the number of column in the dataset.
int
getColumnIndex(Comparable columnKey)
Returns the column index for a column key.
Comparable
getColumnKey(int index)
Returns a column key.
List
getColumnKeys()
Returns a list of the column keys in the dataset.
Number
getEndValue(Comparable rowKey, Comparable columnKey)
Returns the end value for a task.
Number
getEndValue(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the end value of a sub-interval for a given item.
Number
getEndValue(int row, int column)
Returns the end value for a task.
Number
getEndValue(int row, int column, int subinterval)
Returns the end value of a sub-interval for a given item.
Number
getPercentComplete(Comparable rowKey, Comparable columnKey)
Returns the percent complete for a given item.
Number
getPercentComplete(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
Number
getPercentComplete(int row, int column)
Returns the percent complete for a given item.
Number
getPercentComplete(int row, int column, int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
int
getRowCount()
Returns the number of rows (series) in the collection.
int
getRowIndex(Comparable rowKey)
Returns the row index for the given row key.
Comparable
getRowKey(int index)
Returns the key for a row.
List
getRowKeys()
Returns the row keys.
TaskSeries
getSeries(Comparable key)
Returns a series from the collection.
TaskSeries
getSeries(int series)
Returns a series from the collection.
int
getSeriesCount()
Returns the number of series in the collection.
Comparable
getSeriesKey(int series)
Returns the name of a series.
Number
getStartValue(Comparable rowKey, Comparable columnKey)
Returns the start value for a task.
Number
getStartValue(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the start value of a sub-interval for a given item.
Number
getStartValue(int row, int column)
Returns the start value for a task.
Number
getStartValue(int row, int column, int subinterval)
Returns the start value of a sub-interval for a given item.
int
getSubIntervalCount(Comparable rowKey, Comparable columnKey)
Returns the number of sub-intervals for a given item.
int
getSubIntervalCount(int row, int column)
Returns the number of sub-intervals for a given item.
Number
getValue(Comparable rowKey, Comparable columnKey)
Returns the value for an item.
Number
getValue(int row, int column)
Returns the value for a task.
void
remove(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void
remove(TaskSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void
removeAll()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
void
seriesChanged(SeriesChangeEvent event)
Called when a series belonging to the dataset changes.

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

TaskSeriesCollection

public TaskSeriesCollection()
Default constructor.

Method Details

add

public void add(TaskSeries series)
Adds a series to the dataset and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (null not permitted).

equals

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

getColumnCount

public int getColumnCount()
Returns the number of column in the dataset.
Specified by:
getColumnCount in interface Values2D
Returns:
The column count.

getColumnIndex

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

getColumnKey

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

getColumnKeys

public List getColumnKeys()
Returns a list of the column keys in the dataset.
Specified by:
getColumnKeys in interface KeyedValues2D
Returns:
The category list.

getEndValue

public Number getEndValue(Comparable rowKey,
                          Comparable columnKey)
Returns the end value for a task. This is a date/time value, measured in milliseconds since 1-Jan-1970.
Specified by:
getEndValue in interface IntervalCategoryDataset
Parameters:
rowKey - the series.
columnKey - the category.
Returns:
The end value (possibly null).

getEndValue

public Number getEndValue(Comparable rowKey,
                          Comparable columnKey,
                          int subinterval)
Returns the end value of a sub-interval for a given item.
Specified by:
getEndValue in interface GanttCategoryDataset
Parameters:
rowKey - the row key.
columnKey - the column key.
subinterval - the subinterval.
Returns:
The end value (possibly null).

getEndValue

public Number getEndValue(int row,
                          int column)
Returns the end value for a task.
Specified by:
getEndValue in interface IntervalCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The end value.

getEndValue

public Number getEndValue(int row,
                          int column,
                          int subinterval)
Returns the end value of a sub-interval for a given item.
Specified by:
getEndValue in interface GanttCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
subinterval - the subinterval.
Returns:
The end value (possibly null).

getPercentComplete

public Number getPercentComplete(Comparable rowKey,
                                 Comparable columnKey)
Returns the percent complete for a given item.
Specified by:
getPercentComplete in interface GanttCategoryDataset
Parameters:
rowKey - the row key.
columnKey - the column key.
Returns:
The percent complete.

getPercentComplete

public Number getPercentComplete(Comparable rowKey,
                                 Comparable columnKey,
                                 int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
Specified by:
getPercentComplete in interface GanttCategoryDataset
Parameters:
rowKey - the row key.
columnKey - the column key.
subinterval - the sub-interval.
Returns:
The precent complete value (possibly null).

getPercentComplete

public Number getPercentComplete(int row,
                                 int column)
Returns the percent complete for a given item.
Specified by:
getPercentComplete in interface GanttCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The percent complete (possibly null).

getPercentComplete

public Number getPercentComplete(int row,
                                 int column,
                                 int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
Specified by:
getPercentComplete in interface GanttCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
subinterval - the sub-interval.
Returns:
The percent complete value (possibly null).

getRowCount

public int getRowCount()
Returns the number of rows (series) in the collection.
Specified by:
getRowCount in interface Values2D
Returns:
The series count.

getRowIndex

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

getRowKey

public Comparable getRowKey(int index)
Returns the key for a row.
Specified by:
getRowKey in interface KeyedValues2D
Parameters:
index - the row index (zero-based).
Returns:
The key.

getRowKeys

public List getRowKeys()
Returns the row keys. In this case, each series is a key.
Specified by:
getRowKeys in interface KeyedValues2D
Returns:
The row keys.

getSeries

public TaskSeries getSeries(Comparable key)
Returns a series from the collection.
Parameters:
key - the series key (null not permitted).
Returns:
The series.
Since:
1.0.1

getSeries

public TaskSeries getSeries(int series)
Returns a series from the collection.
Parameters:
series - the series index (zero-based).
Returns:
The series.
Since:
1.0.1

getSeriesCount

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

getSeriesKey

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

getStartValue

public Number getStartValue(Comparable rowKey,
                            Comparable columnKey)
Returns the start value for a task. This is a date/time value, measured in milliseconds since 1-Jan-1970.
Specified by:
getStartValue in interface IntervalCategoryDataset
Parameters:
rowKey - the series.
columnKey - the category.
Returns:
The start value (possibly null).

getStartValue

public Number getStartValue(Comparable rowKey,
                            Comparable columnKey,
                            int subinterval)
Returns the start value of a sub-interval for a given item.
Specified by:
getStartValue in interface GanttCategoryDataset
Parameters:
rowKey - the row key.
columnKey - the column key.
subinterval - the subinterval.
Returns:
The start value (possibly null).

getStartValue

public Number getStartValue(int row,
                            int column)
Returns the start value for a task.
Specified by:
getStartValue in interface IntervalCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The start value.

getStartValue

public Number getStartValue(int row,
                            int column,
                            int subinterval)
Returns the start value of a sub-interval for a given item.
Specified by:
getStartValue in interface GanttCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
subinterval - the sub-interval index (zero-based).
Returns:
The start value (possibly null).

getSubIntervalCount

public int getSubIntervalCount(Comparable rowKey,
                               Comparable columnKey)
Returns the number of sub-intervals for a given item.
Specified by:
getSubIntervalCount in interface GanttCategoryDataset
Parameters:
rowKey - the row key.
columnKey - the column key.
Returns:
The sub-interval count.

getSubIntervalCount

public int getSubIntervalCount(int row,
                               int column)
Returns the number of sub-intervals for a given item.
Specified by:
getSubIntervalCount in interface GanttCategoryDataset
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The sub-interval count.

getValue

public Number getValue(Comparable rowKey,
                       Comparable columnKey)
Returns the value for an item.
Specified by:
getValue in interface KeyedValues2D
Parameters:
rowKey - the row key.
columnKey - the column key.
Returns:
The item value.

getValue

public Number getValue(int row,
                       int column)
Returns the value for a task.
Specified by:
getValue in interface Values2D
Parameters:
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The start value.

remove

public void remove(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series (zero based index).

remove

public void remove(TaskSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
Parameters:
series - the series.

removeAll

public void removeAll()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

seriesChanged

public void seriesChanged(SeriesChangeEvent event)
Called when a series belonging to the dataset changes.
Specified by:
seriesChanged in interface SeriesChangeListener
Overrides:
seriesChanged in interface AbstractSeriesDataset
Parameters:
event - information about the change.

Overview Package Class Use Source Tree Index Deprecated About