public class

XYSeriesCollection

extends AbstractIntervalXYDataset
implements Serializable DomainInfo RangeInfo IntervalXYDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.general.AbstractSeriesDataset
       ↳ org.jfree.data.xy.AbstractXYDataset
         ↳ org.jfree.data.xy.AbstractIntervalXYDataset
           ↳ org.jfree.data.xy.XYSeriesCollection

Class Overview

Represents a collection of XYSeries objects that can be used as a dataset.

Summary

Public Constructors
XYSeriesCollection()
Constructs an empty dataset.
XYSeriesCollection(XYSeries series)
Constructs a dataset and populates it with a single series.
Public Methods
void addSeries(XYSeries series)
Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.
Object clone()
Returns a clone of this instance.
boolean equals(Object obj)
Tests this collection for equality with an arbitrary object.
Range getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.
double getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.
DomainOrder getDomainOrder()
Returns the order of the domain (X) values, if this is known.
double getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.
Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.
Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.
double getIntervalPositionFactor()
Returns the interval position factor.
double getIntervalWidth()
Returns the interval width.
int getItemCount(int series)
Returns the number of items in the specified series.
Range getRangeBounds(boolean includeInterval)
Returns the range of the values in this dataset's range.
double getRangeLowerBound(boolean includeInterval)
Returns the minimum y-value in the dataset.
double getRangeUpperBound(boolean includeInterval)
Returns the maximum y-value in the dataset.
XYSeries getSeries(int series)
Returns a series from the collection.
XYSeries getSeries(Comparable key)
Returns a series from the collection.
List getSeries()
Returns a list of all the series in the collection.
int getSeriesCount()
Returns the number of series in the collection.
Comparable getSeriesKey(int series)
Returns the key for a series.
Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.
Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.
Number getX(int series, int item)
Returns the x-value for the specified series and item.
Number getY(int series, int index)
Returns the y-value for the specified series and item.
int hashCode()
Returns a hash code.
int indexOf(XYSeries series)
Returns the index of the specified series, or -1 if that series is not present in the dataset.
boolean isAutoWidth()
Returns whether the interval width is automatically calculated or not.
void removeAllSeries()
Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(XYSeries series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void removeSeries(int series)
Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.
void setAutoWidth(boolean b)
Sets the flag that indicates wether the interval width is automatically calculated or not.
void setIntervalPositionFactor(double factor)
Sets the interval position factor.
void setIntervalWidth(double width)
Sets the interval width and sends a DatasetChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.data.xy.AbstractIntervalXYDataset
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.DomainInfo
From interface org.jfree.data.RangeInfo
From interface org.jfree.data.general.Dataset
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 XYSeriesCollection ()

Constructs an empty dataset.

public XYSeriesCollection (XYSeries series)

Constructs a dataset and populates it with a single series.

Parameters
series the series (null ignored).

Public Methods

public void addSeries (XYSeries series)

Adds a series to the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

public Object clone ()

Returns a clone of this instance.

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

public boolean equals (Object obj)

Tests this collection for equality with an arbitrary object.

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

public Range getDomainBounds (boolean includeInterval)

Returns the range of the values in this dataset's domain.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The range (or null if the dataset contains no values).

public double getDomainLowerBound (boolean includeInterval)

Returns the minimum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The minimum value.

public DomainOrder getDomainOrder ()

Returns the order of the domain (X) values, if this is known.

Returns
  • The domain order.

public double getDomainUpperBound (boolean includeInterval)

Returns the maximum x-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the x-interval is taken into account.
Returns
  • The maximum value.

public Number getEndX (int series, int item)

Returns the ending X value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The ending X value.

public Number getEndY (int series, int item)

Returns the ending Y value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The ending Y value.

public double getIntervalPositionFactor ()

Returns the interval position factor.

Returns
  • The interval position factor.

public double getIntervalWidth ()

Returns the interval width. This is used to calculate the start and end x-values, if/when the dataset is used as an IntervalXYDataset.

Returns
  • The interval width.

public int getItemCount (int series)

Returns the number of items in the specified series.

Parameters
series the series (zero-based index).
Returns
  • The item count.
Throws
IllegalArgumentException if series is not in the range 0 to getSeriesCount() - 1.

public Range getRangeBounds (boolean includeInterval)

Returns the range of the values in this dataset's range.

Parameters
includeInterval ignored.
Returns
  • The range (or null if the dataset contains no values).

public double getRangeLowerBound (boolean includeInterval)

Returns the minimum y-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the y-interval is taken into account.
Returns
  • The minimum value.

public double getRangeUpperBound (boolean includeInterval)

Returns the maximum y-value in the dataset.

Parameters
includeInterval a flag that determines whether or not the y-interval is taken into account.
Returns
  • The maximum value.

public XYSeries getSeries (int series)

Returns a series from the collection.

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

public XYSeries getSeries (Comparable key)

Returns a series from the collection.

Parameters
key the key (null not permitted).
Returns
  • The series with the specified key.
Throws
UnknownKeyException if key is not found in the collection.

public List getSeries ()

Returns a list of all the series in the collection.

Returns
  • The list (which is unmodifiable).

public int getSeriesCount ()

Returns the number of series in the collection.

Returns
  • The series count.

public Comparable getSeriesKey (int series)

Returns the key for a series.

Parameters
series the series index (in the range 0 to getSeriesCount() - 1).
Returns
  • The key for a series.
Throws
IllegalArgumentException if series is not in the specified range.

public Number getStartX (int series, int item)

Returns the starting X value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The starting X value.

public Number getStartY (int series, int item)

Returns the starting Y value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The starting Y value.

public Number getX (int series, int item)

Returns the x-value for the specified series and item.

Parameters
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The value.

public Number getY (int series, int index)

Returns the y-value for the specified series and item.

Parameters
series the series (zero-based index).
index the index of the item of interest (zero-based).
Returns
  • The value (possibly null).

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public int indexOf (XYSeries series)

Returns the index of the specified series, or -1 if that series is not present in the dataset.

Parameters
series the series (null not permitted).
Returns
  • The series index.

public boolean isAutoWidth ()

Returns whether the interval width is automatically calculated or not.

Returns
  • Whether the width is automatically calculated or not.

public void removeAllSeries ()

Removes all the series from the collection and sends a DatasetChangeEvent to all registered listeners.

public void removeSeries (XYSeries series)

Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series (null not permitted).

public void removeSeries (int series)

Removes a series from the collection and sends a DatasetChangeEvent to all registered listeners.

Parameters
series the series index (zero-based).

public void setAutoWidth (boolean b)

Sets the flag that indicates wether the interval width is automatically calculated or not.

Parameters
b a boolean.

public void setIntervalPositionFactor (double factor)

Sets the interval position factor. This controls where the x-value is in relation to the interval surrounding the x-value (0.0 means the x-value will be positioned at the start, 0.5 in the middle, and 1.0 at the end).

Parameters
factor the factor.

public void setIntervalWidth (double width)

Sets the interval width and sends a DatasetChangeEvent to all registered listeners.

Parameters
width the width (negative values not permitted).