org.jfree.data.time.TimePeriodValuesCollection Maven / Gradle / Ivy
Show all versions of jfreechart Show documentation
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------------------------
* TimePeriodValuesCollection.java
* -------------------------------
* (C) Copyright 2003-2013, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 22-Apr-2003 : Version 1 (DG);
* 05-May-2004 : Now extends AbstractIntervalXYDataset (DG);
* 15-Jul-2004 : Switched getX() with getXValue() and getY() with
* getYValue() (DG);
* 06-Oct-2004 : Updated for changes in DomainInfo interface (DG);
* 11-Jan-2005 : Removed deprecated code in preparation for 1.0.0 release (DG);
* ------------- JFREECHART 1.0.x ---------------------------------------------
* 03-Oct-2006 : Deprecated get/setDomainIsPointsInTime() (DG);
* 11-Jun-2007 : Fixed bug in getDomainBounds() method, and changed default
* value for domainIsPointsInTime to false (DG);
* 03-Jul-2013 : Use ParamChecks (DG);
*
*/
package org.jfree.data.time;
import java.io.Serializable;
import java.util.Iterator;
import java.util.List;
import org.jfree.chart.util.ParamChecks;
import org.jfree.data.DomainInfo;
import org.jfree.data.Range;
import org.jfree.data.xy.AbstractIntervalXYDataset;
import org.jfree.data.xy.IntervalXYDataset;
import org.jfree.util.ObjectUtilities;
/**
* A collection of {@link TimePeriodValues} objects.
*
* This class implements the {@link org.jfree.data.xy.XYDataset} interface, as
* well as the extended {@link IntervalXYDataset} interface. This makes it a
* convenient dataset for use with the {@link org.jfree.chart.plot.XYPlot}
* class.
*/
public class TimePeriodValuesCollection extends AbstractIntervalXYDataset
implements IntervalXYDataset, DomainInfo, Serializable {
/** For serialization. */
private static final long serialVersionUID = -3077934065236454199L;
/** Storage for the time series. */
private List data;
/**
* The position within a time period to return as the x-value (START,
* MIDDLE or END).
*/
private TimePeriodAnchor xPosition;
/**
* A flag that indicates that the domain is 'points in time'. If this
* flag is true, only the x-value is used to determine the range of values
* in the domain, the start and end x-values are ignored.
*/
private boolean domainIsPointsInTime;
/**
* Constructs an empty dataset.
*/
public TimePeriodValuesCollection() {
this((TimePeriodValues) null);
}
/**
* Constructs a dataset containing a single series. Additional series can
* be added.
*
* @param series the series (null ignored).
*/
public TimePeriodValuesCollection(TimePeriodValues series) {
this.data = new java.util.ArrayList();
this.xPosition = TimePeriodAnchor.MIDDLE;
this.domainIsPointsInTime = false;
if (series != null) {
this.data.add(series);
series.addChangeListener(this);
}
}
/**
* Returns the position of the X value within each time period.
*
* @return The position (never null).
*
* @see #setXPosition(TimePeriodAnchor)
*/
public TimePeriodAnchor getXPosition() {
return this.xPosition;
}
/**
* Sets the position of the x axis within each time period.
*
* @param position the position (null not permitted).
*
* @see #getXPosition()
*/
public void setXPosition(TimePeriodAnchor position) {
ParamChecks.nullNotPermitted(position, "position");
this.xPosition = position;
}
/**
* Returns the number of series in the collection.
*
* @return The series count.
*/
@Override
public int getSeriesCount() {
return this.data.size();
}
/**
* Returns a series.
*
* @param series the index of the series (zero-based).
*
* @return The series.
*/
public TimePeriodValues getSeries(int series) {
if ((series < 0) || (series >= getSeriesCount())) {
throw new IllegalArgumentException("Index 'series' out of range.");
}
return (TimePeriodValues) this.data.get(series);
}
/**
* Returns the key for a series.
*
* @param series the index of the series (zero-based).
*
* @return The key for a series.
*/
@Override
public Comparable getSeriesKey(int series) {
// defer argument checking
return getSeries(series).getKey();
}
/**
* Adds a series to the collection. A
* {@link org.jfree.data.general.DatasetChangeEvent} is sent to all
* registered listeners.
*
* @param series the time series.
*/
public void addSeries(TimePeriodValues series) {
ParamChecks.nullNotPermitted(series, "series");
this.data.add(series);
series.addChangeListener(this);
fireDatasetChanged();
}
/**
* Removes the specified series from the collection.
*
* @param series the series to remove (null not permitted).
*/
public void removeSeries(TimePeriodValues series) {
ParamChecks.nullNotPermitted(series, "series");
this.data.remove(series);
series.removeChangeListener(this);
fireDatasetChanged();
}
/**
* Removes a series from the collection.
*
* @param index the series index (zero-based).
*/
public void removeSeries(int index) {
TimePeriodValues series = getSeries(index);
if (series != null) {
removeSeries(series);
}
}
/**
* Returns the number of items in the specified series.
*
* This method is provided for convenience.
*
* @param series the index of the series of interest (zero-based).
*
* @return The number of items in the specified series.
*/
@Override
public int getItemCount(int series) {
return getSeries(series).getItemCount();
}
/**
* Returns the x-value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The x-value for the specified series and item.
*/
@Override
public Number getX(int series, int item) {
TimePeriodValues ts = (TimePeriodValues) this.data.get(series);
TimePeriodValue dp = ts.getDataItem(item);
TimePeriod period = dp.getPeriod();
return new Long(getX(period));
}
/**
* Returns the x-value for a time period.
*
* @param period the time period.
*
* @return The x-value.
*/
private long getX(TimePeriod period) {
if (this.xPosition == TimePeriodAnchor.START) {
return period.getStart().getTime();
}
else if (this.xPosition == TimePeriodAnchor.MIDDLE) {
return period.getStart().getTime()
/ 2 + period.getEnd().getTime() / 2;
}
else if (this.xPosition == TimePeriodAnchor.END) {
return period.getEnd().getTime();
}
else {
throw new IllegalStateException("TimePeriodAnchor unknown.");
}
}
/**
* Returns the starting X value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The starting X value for the specified series and item.
*/
@Override
public Number getStartX(int series, int item) {
TimePeriodValues ts = (TimePeriodValues) this.data.get(series);
TimePeriodValue dp = ts.getDataItem(item);
return new Long(dp.getPeriod().getStart().getTime());
}
/**
* Returns the ending X value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The ending X value for the specified series and item.
*/
@Override
public Number getEndX(int series, int item) {
TimePeriodValues ts = (TimePeriodValues) this.data.get(series);
TimePeriodValue dp = ts.getDataItem(item);
return new Long(dp.getPeriod().getEnd().getTime());
}
/**
* Returns the y-value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The y-value for the specified series and item.
*/
@Override
public Number getY(int series, int item) {
TimePeriodValues ts = (TimePeriodValues) this.data.get(series);
TimePeriodValue dp = ts.getDataItem(item);
return dp.getValue();
}
/**
* Returns the starting Y value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The starting Y value for the specified series and item.
*/
@Override
public Number getStartY(int series, int item) {
return getY(series, item);
}
/**
* Returns the ending Y value for the specified series and item.
*
* @param series the series (zero-based index).
* @param item the item (zero-based index).
*
* @return The ending Y value for the specified series and item.
*/
@Override
public Number getEndY(int series, int item) {
return getY(series, item);
}
/**
* Returns the minimum x-value in the dataset.
*
* @param includeInterval a flag that determines whether or not the
* x-interval is taken into account.
*
* @return The minimum value.
*/
@Override
public double getDomainLowerBound(boolean includeInterval) {
double result = Double.NaN;
Range r = getDomainBounds(includeInterval);
if (r != null) {
result = r.getLowerBound();
}
return result;
}
/**
* Returns the maximum x-value in the dataset.
*
* @param includeInterval a flag that determines whether or not the
* x-interval is taken into account.
*
* @return The maximum value.
*/
@Override
public double getDomainUpperBound(boolean includeInterval) {
double result = Double.NaN;
Range r = getDomainBounds(includeInterval);
if (r != null) {
result = r.getUpperBound();
}
return result;
}
/**
* Returns the range of the values in this dataset's domain.
*
* @param includeInterval a flag that determines whether or not the
* x-interval is taken into account.
*
* @return The range.
*/
@Override
public Range getDomainBounds(boolean includeInterval) {
boolean interval = includeInterval || this.domainIsPointsInTime;
Range result = null;
Range temp = null;
Iterator iterator = this.data.iterator();
while (iterator.hasNext()) {
TimePeriodValues series = (TimePeriodValues) iterator.next();
int count = series.getItemCount();
if (count > 0) {
TimePeriod start = series.getTimePeriod(
series.getMinStartIndex());
TimePeriod end = series.getTimePeriod(series.getMaxEndIndex());
if (!interval) {
if (this.xPosition == TimePeriodAnchor.START) {
TimePeriod maxStart = series.getTimePeriod(
series.getMaxStartIndex());
temp = new Range(start.getStart().getTime(),
maxStart.getStart().getTime());
}
else if (this.xPosition == TimePeriodAnchor.MIDDLE) {
TimePeriod minMiddle = series.getTimePeriod(
series.getMinMiddleIndex());
long s1 = minMiddle.getStart().getTime();
long e1 = minMiddle.getEnd().getTime();
TimePeriod maxMiddle = series.getTimePeriod(
series.getMaxMiddleIndex());
long s2 = maxMiddle.getStart().getTime();
long e2 = maxMiddle.getEnd().getTime();
temp = new Range(s1 + (e1 - s1) / 2,
s2 + (e2 - s2) / 2);
}
else if (this.xPosition == TimePeriodAnchor.END) {
TimePeriod minEnd = series.getTimePeriod(
series.getMinEndIndex());
temp = new Range(minEnd.getEnd().getTime(),
end.getEnd().getTime());
}
}
else {
temp = new Range(start.getStart().getTime(),
end.getEnd().getTime());
}
result = Range.combine(result, temp);
}
}
return result;
}
/**
* Tests this instance for equality with an arbitrary object.
*
* @param obj the object (null permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof TimePeriodValuesCollection)) {
return false;
}
TimePeriodValuesCollection that = (TimePeriodValuesCollection) obj;
if (this.domainIsPointsInTime != that.domainIsPointsInTime) {
return false;
}
if (this.xPosition != that.xPosition) {
return false;
}
if (!ObjectUtilities.equal(this.data, that.data)) {
return false;
}
return true;
}
// --- DEPRECATED METHODS -------------------------------------------------
/**
* Returns a flag that controls whether the domain is treated as 'points
* in time'. This flag is used when determining the max and min values for
* the domain. If true, then only the x-values are considered for the max
* and min values. If false, then the start and end x-values will also be
* taken into consideration
*
* @return The flag.
*
* @deprecated This flag is no longer used by JFreeChart (as of version
* 1.0.3).
*/
public boolean getDomainIsPointsInTime() {
return this.domainIsPointsInTime;
}
/**
* Sets a flag that controls whether the domain is treated as 'points in
* time', or time periods.
*
* @param flag the new value of the flag.
*
* @deprecated This flag is no longer used by JFreeChart (as of version
* 1.0.3).
*/
public void setDomainIsPointsInTime(boolean flag) {
this.domainIsPointsInTime = flag;
}
}