org.jfree.data.xy
Class XIntervalSeriesCollection

java.lang.Object
  extended byorg.jfree.data.general.AbstractDataset
      extended byorg.jfree.data.general.AbstractSeriesDataset
          extended byorg.jfree.data.xy.AbstractXYDataset
              extended byorg.jfree.data.xy.AbstractIntervalXYDataset
                  extended byorg.jfree.data.xy.XIntervalSeriesCollection
All Implemented Interfaces:
java.lang.Cloneable, Dataset, java.util.EventListener, IntervalXYDataset, java.io.ObjectInputValidation, java.io.Serializable, SeriesChangeListener, SeriesDataset, XYDataset

public class XIntervalSeriesCollection
extends AbstractIntervalXYDataset
implements IntervalXYDataset, java.io.Serializable

A collection of XIntervalSeries objects.

Since:
1.0.3
See Also:
XIntervalSeries, Serialized Form

Constructor Summary
XIntervalSeriesCollection()
          Creates a new instance of XIntervalSeriesCollection.
 
Method Summary
 void addSeries(XIntervalSeries series)
          Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
 java.lang.Object clone()
          Returns a clone of this instance.
 boolean equals(java.lang.Object obj)
          Tests this instance for equality with an arbitrary object.
 java.lang.Number getEndX(int series, int item)
          Returns the end x-value for an item within a series.
 java.lang.Number getEndY(int series, int item)
          Returns the end y-value for an item within a series.
 int getItemCount(int series)
          Returns the number of items in the specified series.
 XIntervalSeries getSeries(int series)
          Returns a series from the collection.
 int getSeriesCount()
          Returns the number of series in the collection.
 java.lang.Comparable getSeriesKey(int series)
          Returns the key for a series.
 java.lang.Number getStartX(int series, int item)
          Returns the start x-value for an item within a series.
 java.lang.Number getStartY(int series, int item)
          Returns the start y-value for an item within a series.
 java.lang.Number getX(int series, int item)
          Returns the x-value for an item within a series.
 java.lang.Number getY(int series, int item)
          Returns the y-value for an item within a series.
 
Methods inherited from class org.jfree.data.xy.AbstractIntervalXYDataset
getEndXValue, getEndYValue, getStartXValue, getStartYValue
 
Methods inherited from class org.jfree.data.xy.AbstractXYDataset
getDomainOrder, getXValue, getYValue
 
Methods inherited from class org.jfree.data.general.AbstractSeriesDataset
indexOf, seriesChanged
 
Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.data.xy.IntervalXYDataset
getEndXValue, getEndYValue, getStartXValue, getStartYValue
 
Methods inherited from interface org.jfree.data.xy.XYDataset
getDomainOrder, getXValue, getYValue
 
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
 
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
 

Constructor Detail

XIntervalSeriesCollection

public XIntervalSeriesCollection()
Creates a new instance of XIntervalSeriesCollection.

Method Detail

addSeries

public void addSeries(XIntervalSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters:
series - the series (null not permitted).

getSeriesCount

public int getSeriesCount()
Returns the number of series in the collection.

Specified by:
getSeriesCount in interface SeriesDataset
Specified by:
getSeriesCount in class AbstractSeriesDataset
Returns:
The series count.

getSeries

public XIntervalSeries getSeries(int series)
Returns a series from the collection.

Parameters:
series - the series index (zero-based).
Returns:
The series.
Throws:
java.lang.IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.

getSeriesKey

public java.lang.Comparable getSeriesKey(int series)
Returns the key for a series.

Specified by:
getSeriesKey in interface SeriesDataset
Specified by:
getSeriesKey in class AbstractSeriesDataset
Parameters:
series - the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for a series.
Throws:
java.lang.IllegalArgumentException - if series is not in the specified range.

getItemCount

public int getItemCount(int series)
Returns the number of items in the specified series.

Specified by:
getItemCount in interface XYDataset
Parameters:
series - the series (zero-based index).
Returns:
The item count.
Throws:
java.lang.IllegalArgumentException - if series is not in the range 0 to getSeriesCount() - 1.

getX

public java.lang.Number getX(int series,
                             int item)
Returns the x-value for an item within a series.

Specified by:
getX in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getY

public java.lang.Number getY(int series,
                             int item)
Returns the y-value for an item within a series.

Specified by:
getY in interface XYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The y-value.

getStartX

public java.lang.Number getStartX(int series,
                                  int item)
Returns the start x-value for an item within a series.

Specified by:
getStartX in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getEndX

public java.lang.Number getEndX(int series,
                                int item)
Returns the end x-value for an item within a series.

Specified by:
getEndX in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The x-value.

getStartY

public java.lang.Number getStartY(int series,
                                  int item)
Returns the start y-value for an item within a series. This method maps directly to getY(int, int).

Specified by:
getStartY in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The start y-value.

getEndY

public java.lang.Number getEndY(int series,
                                int item)
Returns the end y-value for an item within a series. This method maps directly to getY(int, int).

Specified by:
getEndY in interface IntervalXYDataset
Parameters:
series - the series index.
item - the item index.
Returns:
The end y-value.

equals

public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of this instance.

Overrides:
clone in class AbstractDataset
Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - if there is a problem.