XYTaskDataset
extends AbstractXYDatasetimplements DatasetChangeListener IntervalXYDataset
| java.lang.Object | ||||
| ↳ | org.jfree.data.general.AbstractDataset | |||
| ↳ | org.jfree.data.general.AbstractSeriesDataset | |||
| ↳ | org.jfree.data.xy.AbstractXYDataset | |||
| ↳ | org.jfree.data.gantt.XYTaskDataset | |||
Class Overview
A dataset implementation that wraps a TaskSeriesCollection and
presents it as an IntervalXYDataset, allowing a set of tasks to
be displayed using an XYBarRenderer (and usually a
SymbolAxis). This is a very specialised dataset implementation
---before using it, you should take some time to understand the use-cases
that it is designed for.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new dataset based on the supplied collection of tasks.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns a clone of this dataset.
| |||||||||||
Receives a change event from the underlying dataset and responds by
firing a change event for this dataset.
| |||||||||||
Tests this dataset for equality with an arbitrary object.
| |||||||||||
Returns the ending date/time for the specified item (task) in the
given series, measured in milliseconds since 1-Jan-1970 (as in
java.util.Date).
| |||||||||||
Returns the ending date/time for the specified item (task) in the
given series, measured in milliseconds since 1-Jan-1970 (as in
java.util.Date).
| |||||||||||
Returns the ending value of the y-interval for an item in the
given series.
| |||||||||||
Returns the ending value of the y-interval for an item in the
given series.
| |||||||||||
Returns the number of items (tasks) in the specified series.
| |||||||||||
Returns the number of series in the dataset.
| |||||||||||
Returns the name of a series.
| |||||||||||
Returns the width of the interval for each series this dataset.
| |||||||||||
Returns the starting date/time for the specified item (task) in the
given series, measured in milliseconds since 1-Jan-1970 (as in
java.util.Date).
| |||||||||||
Returns the starting date/time for the specified item (task) in the
given series, measured in milliseconds since 1-Jan-1970 (as in
java.util.Date).
| |||||||||||
Returns the starting value of the y-interval for an item in the
given series.
| |||||||||||
Returns the starting value of the y-interval for an item in the
given series.
| |||||||||||
Returns the underlying task series collection that was supplied to the
constructor.
| |||||||||||
Returns the x-value for the specified series.
| |||||||||||
Returns the x-value (as a double primitive) for an item within a series.
| |||||||||||
Returns the y-value for the specified series/item.
| |||||||||||
Returns the y-value (as a double primitive) for an item within a series.
| |||||||||||
Returns a flag that indicates whether or not the dataset is transposed.
| |||||||||||
Sets the series interval width and sends a
DatasetChangeEvent to
all registered listeners. | |||||||||||
Sets the flag that controls whether or not the dataset is transposed
and sends a
DatasetChangeEvent to all registered listeners. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.jfree.data.xy.AbstractXYDataset
| |||||||||||
|
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.general.Dataset
| |||||||||||
|
From interface
org.jfree.data.general.DatasetChangeListener
| |||||||||||
|
From interface
org.jfree.data.general.SeriesChangeListener
| |||||||||||
|
From interface
org.jfree.data.general.SeriesDataset
| |||||||||||
|
From interface
org.jfree.data.xy.IntervalXYDataset
| |||||||||||
|
From interface
org.jfree.data.xy.XYDataset
| |||||||||||
Public Constructors
public XYTaskDataset (TaskSeriesCollection tasks)
Creates a new dataset based on the supplied collection of tasks.
Parameters
| tasks | the underlying dataset (null not permitted).
|
|---|
Public Methods
public Object clone ()
Returns a clone of this dataset.
Returns
- A clone of this dataset.
Throws
| CloneNotSupportedException | if there is a problem cloning. |
|---|
public void datasetChanged (DatasetChangeEvent event)
Receives a change event from the underlying dataset and responds by firing a change event for this dataset.
Parameters
| event | the event. |
|---|
public boolean equals (Object obj)
Tests this dataset for equality with an arbitrary object.
Parameters
| obj | the object (null permitted). |
|---|
Returns
- A boolean.
public Number getEndX (int series, int item)
Returns the ending date/time for the specified item (task) in the given series, measured in milliseconds since 1-Jan-1970 (as in java.util.Date).
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The end date/time.
public double getEndXValue (int series, int item)
Returns the ending date/time for the specified item (task) in the given series, measured in milliseconds since 1-Jan-1970 (as in java.util.Date).
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The end date/time.
public Number getEndY (int series, int item)
Returns the ending value of the y-interval for an item in the given series.
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The y-interval end.
public double getEndYValue (int series, int item)
Returns the ending value of the y-interval for an item in the given series.
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The y-interval end.
public int getItemCount (int series)
Returns the number of items (tasks) in the specified series.
Parameters
| series | the series index (zero-based). |
|---|
Returns
- The item count.
public int getSeriesCount ()
Returns the number of series in the dataset.
Returns
- The series count.
public Comparable getSeriesKey (int series)
Returns the name of a series.
Parameters
| series | the series index (zero-based). |
|---|
Returns
- The name of a series.
public double getSeriesWidth ()
Returns the width of the interval for each series this dataset.
Returns
- The width of the series interval.
See Also
public Number getStartX (int series, int item)
Returns the starting date/time for the specified item (task) in the given series, measured in milliseconds since 1-Jan-1970 (as in java.util.Date).
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The start date/time.
public double getStartXValue (int series, int item)
Returns the starting date/time for the specified item (task) in the given series, measured in milliseconds since 1-Jan-1970 (as in java.util.Date).
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The start date/time.
public Number getStartY (int series, int item)
Returns the starting value of the y-interval for an item in the given series.
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The y-interval start.
public double getStartYValue (int series, int item)
Returns the starting value of the y-interval for an item in the given series.
Parameters
| series | the series index. |
|---|---|
| item | the item (or task) index. |
Returns
- The y-interval start.
public TaskSeriesCollection getTasks ()
Returns the underlying task series collection that was supplied to the constructor.
Returns
- The underlying collection (never
null).
public Number getX (int series, int item)
Returns the x-value for the specified series.
Parameters
| series | the series index. |
|---|---|
| item | the item index. |
Returns
- The x-value (in milliseconds).
public double getXValue (int series, int item)
Returns the x-value (as a double primitive) for an item within a series.
Parameters
| series | the series index (zero-based). |
|---|---|
| item | the item index (zero-based). |
Returns
- The value.
public Number getY (int series, int item)
Returns the y-value for the specified series/item. In this implementation, we return the series index as the y-value (this means that every item in the series has a constant integer value).
Parameters
| series | the series index. |
|---|---|
| item | the item index. |
Returns
- The y-value.
public double getYValue (int series, int item)
Returns the y-value (as a double primitive) for an item within a series.
Parameters
| series | the series index (zero-based). |
|---|---|
| item | the item index (zero-based). |
Returns
- The value.
public boolean isTransposed ()
Returns a flag that indicates whether or not the dataset is transposed.
The default is false which means the x-values are integers
corresponding to the series indices, and the y-values are millisecond
values corresponding to the task date/time intervals. If the flag
is set to true, the x and y-values are reversed.
Returns
- The flag.
See Also
public void setSeriesWidth (double w)
Sets the series interval width and sends a DatasetChangeEvent to
all registered listeners.
Parameters
| w | the width. |
|---|
See Also
public void setTransposed (boolean transposed)
Sets the flag that controls whether or not the dataset is transposed
and sends a DatasetChangeEvent to all registered listeners.
Parameters
| transposed | the new flag value. |
|---|