Package org.jfree.data.time
Class TimePeriodValuesCollection
- 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.time.TimePeriodValuesCollection
-
- All Implemented Interfaces:
java.io.ObjectInputValidation
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,DomainInfo
,Dataset
,SeriesChangeListener
,SeriesDataset
,IntervalXYDataset
,XYDataset
public class TimePeriodValuesCollection extends AbstractIntervalXYDataset implements IntervalXYDataset, DomainInfo, java.io.Serializable
A collection ofTimePeriodValues
objects.This class implements the
XYDataset
interface, as well as the extendedIntervalXYDataset
interface. This makes it a convenient dataset for use with theXYPlot
class.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List
data
Storage for the time series.private static long
serialVersionUID
For serialization.private TimePeriodAnchor
xPosition
The position within a time period to return as the x-value (START, MIDDLE or END).
-
Constructor Summary
Constructors Constructor Description TimePeriodValuesCollection()
Constructs an empty dataset.TimePeriodValuesCollection(TimePeriodValues series)
Constructs a dataset containing a single series.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSeries(TimePeriodValues series)
Adds a series to the collection.boolean
equals(java.lang.Object obj)
Tests this instance 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.double
getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.java.lang.Number
getEndX(int series, int item)
Returns the ending X value for the specified series and item.java.lang.Number
getEndY(int series, int item)
Returns the ending Y value for the specified series and item.int
getItemCount(int series)
Returns the number of items in the specified series.TimePeriodValues
getSeries(int series)
Returns a series.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 starting X value for the specified series and item.java.lang.Number
getStartY(int series, int item)
Returns the starting Y value for the specified series and item.java.lang.Number
getX(int series, int item)
Returns the x-value for the specified series and item.private long
getX(TimePeriod period)
Returns the x-value for a time period.TimePeriodAnchor
getXPosition()
Returns the position of the X value within each time period.java.lang.Number
getY(int series, int item)
Returns the y-value for the specified series and item.void
removeSeries(int index)
Removes a series from the collection.void
removeSeries(TimePeriodValues series)
Removes the specified series from the collection.void
setXPosition(TimePeriodAnchor position)
Sets the position of the x axis within each time period.-
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, canEqual, clone, fireDatasetChanged, getGroup, getNotify, hashCode, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
-
Methods inherited from interface org.jfree.data.xy.IntervalXYDataset
getEndXValue, getEndYValue, getStartXValue, getStartYValue
-
Methods inherited from interface org.jfree.data.general.SeriesDataset
indexOf
-
Methods inherited from interface org.jfree.data.xy.XYDataset
getDomainOrder, getXValue, getYValue
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
data
private java.util.List data
Storage for the time series.
-
xPosition
private TimePeriodAnchor xPosition
The position within a time period to return as the x-value (START, MIDDLE or END).
-
-
Constructor Detail
-
TimePeriodValuesCollection
public TimePeriodValuesCollection()
Constructs an empty dataset.
-
TimePeriodValuesCollection
public TimePeriodValuesCollection(TimePeriodValues series)
Constructs a dataset containing a single series. Additional series can be added.- Parameters:
series
- the series (null
ignored).
-
-
Method Detail
-
getXPosition
public TimePeriodAnchor getXPosition()
Returns the position of the X value within each time period.- Returns:
- The position (never
null
). - See Also:
setXPosition(TimePeriodAnchor)
-
setXPosition
public void setXPosition(TimePeriodAnchor position)
Sets the position of the x axis within each time period.- Parameters:
position
- the position (null
not permitted).- See Also:
getXPosition()
-
getSeriesCount
public int getSeriesCount()
Returns the number of series in the collection.- Specified by:
getSeriesCount
in interfaceSeriesDataset
- Specified by:
getSeriesCount
in classAbstractSeriesDataset
- Returns:
- The series count.
-
getSeries
public TimePeriodValues getSeries(int series)
Returns a series.- Parameters:
series
- the index of the series (zero-based).- Returns:
- The series.
-
getSeriesKey
public java.lang.Comparable getSeriesKey(int series)
Returns the key for a series.- Specified by:
getSeriesKey
in interfaceSeriesDataset
- Specified by:
getSeriesKey
in classAbstractSeriesDataset
- Parameters:
series
- the index of the series (zero-based).- Returns:
- The key for a series.
-
addSeries
public void addSeries(TimePeriodValues series)
Adds a series to the collection. ADatasetChangeEvent
is sent to all registered listeners.- Parameters:
series
- the time series.
-
removeSeries
public void removeSeries(TimePeriodValues series)
Removes the specified series from the collection.- Parameters:
series
- the series to remove (null
not permitted).
-
removeSeries
public void removeSeries(int index)
Removes a series from the collection.- Parameters:
index
- the series index (zero-based).
-
getItemCount
public int getItemCount(int series)
Returns the number of items in the specified series.This method is provided for convenience.
- Specified by:
getItemCount
in interfaceXYDataset
- Parameters:
series
- the index of the series of interest (zero-based).- Returns:
- The number of items in the specified series.
-
getX
public java.lang.Number getX(int series, int item)
Returns the x-value for the specified series and item.
-
getX
private long getX(TimePeriod period)
Returns the x-value for a time period.- Parameters:
period
- the time period.- Returns:
- The x-value.
-
getStartX
public java.lang.Number getStartX(int series, int item)
Returns the starting X value for the specified series and item.- Specified by:
getStartX
in interfaceIntervalXYDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The starting X value for the specified series and item.
-
getEndX
public java.lang.Number getEndX(int series, int item)
Returns the ending X value for the specified series and item.- Specified by:
getEndX
in interfaceIntervalXYDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The ending X value for the specified series and item.
-
getY
public java.lang.Number getY(int series, int item)
Returns the y-value for the specified series and item.
-
getStartY
public java.lang.Number getStartY(int series, int item)
Returns the starting Y value for the specified series and item.- Specified by:
getStartY
in interfaceIntervalXYDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The starting Y value for the specified series and item.
-
getEndY
public java.lang.Number getEndY(int series, int item)
Returns the ending Y value for the specified series and item.- Specified by:
getEndY
in interfaceIntervalXYDataset
- Parameters:
series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The ending Y value for the specified series and item.
-
getDomainLowerBound
public double getDomainLowerBound(boolean includeInterval)
Returns the minimum x-value in the dataset.- Specified by:
getDomainLowerBound
in interfaceDomainInfo
- Parameters:
includeInterval
- a flag that determines whether or not the x-interval is taken into account.- Returns:
- The minimum value.
-
getDomainUpperBound
public double getDomainUpperBound(boolean includeInterval)
Returns the maximum x-value in the dataset.- Specified by:
getDomainUpperBound
in interfaceDomainInfo
- Parameters:
includeInterval
- a flag that determines whether or not the x-interval is taken into account.- Returns:
- The maximum value.
-
getDomainBounds
public Range getDomainBounds(boolean includeInterval)
Returns the range of the values in this dataset's domain.- Specified by:
getDomainBounds
in interfaceDomainInfo
- Parameters:
includeInterval
- a flag that determines whether or not the x-interval is taken into account.- Returns:
- The range.
-
equals
public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.- Overrides:
equals
in classAbstractDataset
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
-