org.jfree.data.xy.VectorSeriesCollection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D APIs, it currently supports bar charts, pie charts,
line charts, XY-plots and time series plots.
/* ===========================================================
* 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.]
*
* ---------------------------
* VectorSeriesCollection.java
* ---------------------------
* (C) Copyright 2007-2013, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 30-Jan-2007 : Version 1 (DG);
* 24-May-2007 : Added indexOf(), removeSeries() and removeAllSeries()
* methods (DG);
* 25-May-2007 : Moved from experimental to the main source tree (DG);
* 22-Apr-2008 : Implemented PublicCloneable (DG);
* 02-Jul-2013 : Use ParamChecks (DG);
*
*/
package org.jfree.data.xy;
import java.io.Serializable;
import java.util.List;
import org.jfree.chart.util.ParamChecks;
import org.jfree.data.general.DatasetChangeEvent;
import org.jfree.util.ObjectUtilities;
import org.jfree.util.PublicCloneable;
/**
* A collection of {@link VectorSeries} objects.
*
* @since 1.0.6
*/
public class VectorSeriesCollection extends AbstractXYDataset
implements VectorXYDataset, PublicCloneable, Serializable {
/** Storage for the data series. */
private List data;
/**
* Creates a new instance of VectorSeriesCollection.
*/
public VectorSeriesCollection() {
this.data = new java.util.ArrayList();
}
/**
* Adds a series to the collection and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param series the series (null not permitted).
*/
public void addSeries(VectorSeries series) {
ParamChecks.nullNotPermitted(series, "series");
this.data.add(series);
series.addChangeListener(this);
fireDatasetChanged();
}
/**
* Removes the specified series from the collection and sends a
* {@link DatasetChangeEvent} to all registered listeners.
*
* @param series the series (null not permitted).
*
* @return A boolean indicating whether the series has actually been
* removed.
*/
public boolean removeSeries(VectorSeries series) {
ParamChecks.nullNotPermitted(series, "series");
boolean removed = this.data.remove(series);
if (removed) {
series.removeChangeListener(this);
fireDatasetChanged();
}
return removed;
}
/**
* Removes all the series from the collection and sends a
* {@link DatasetChangeEvent} to all registered listeners.
*/
public void removeAllSeries() {
// deregister the collection as a change listener to each series in the
// collection
for (int i = 0; i < this.data.size(); i++) {
VectorSeries series = (VectorSeries) this.data.get(i);
series.removeChangeListener(this);
}
// remove all the series from the collection and notify listeners.
this.data.clear();
fireDatasetChanged();
}
/**
* Returns the number of series in the collection.
*
* @return The series count.
*/
@Override
public int getSeriesCount() {
return this.data.size();
}
/**
* Returns a series from the collection.
*
* @param series the series index (zero-based).
*
* @return The series.
*
* @throws IllegalArgumentException if series is not in the
* range 0 to getSeriesCount() - 1.
*/
public VectorSeries getSeries(int series) {
if ((series < 0) || (series >= getSeriesCount())) {
throw new IllegalArgumentException("Series index out of bounds");
}
return (VectorSeries) this.data.get(series);
}
/**
* Returns the key for a series.
*
* @param series the series index (in the range 0 to
* getSeriesCount() - 1).
*
* @return The key for a series.
*
* @throws IllegalArgumentException if series is not in the
* specified range.
*/
@Override
public Comparable getSeriesKey(int series) {
// defer argument checking
return getSeries(series).getKey();
}
/**
* Returns the index of the specified series, or -1 if that series is not
* present in the dataset.
*
* @param series the series (null not permitted).
*
* @return The series index.
*/
public int indexOf(VectorSeries series) {
ParamChecks.nullNotPermitted(series, "series");
return this.data.indexOf(series);
}
/**
* Returns the number of items in the specified series.
*
* @param series the series (zero-based index).
*
* @return The item count.
*
* @throws IllegalArgumentException if series is not in the
* range 0 to getSeriesCount() - 1.
*/
@Override
public int getItemCount(int series) {
// defer argument checking
return getSeries(series).getItemCount();
}
/**
* Returns the x-value for an item within a series.
*
* @param series the series index.
* @param item the item index.
*
* @return The x-value.
*/
@Override
public double getXValue(int series, int item) {
VectorSeries s = (VectorSeries) this.data.get(series);
VectorDataItem di = (VectorDataItem) s.getDataItem(item);
return di.getXValue();
}
/**
* Returns the x-value for an item within a series. Note that this method
* creates a new {@link Double} instance every time it is called---use
* {@link #getXValue(int, int)} instead, if possible.
*
* @param series the series index.
* @param item the item index.
*
* @return The x-value.
*/
@Override
public Number getX(int series, int item) {
return new Double(getXValue(series, item));
}
/**
* Returns the y-value for an item within a series.
*
* @param series the series index.
* @param item the item index.
*
* @return The y-value.
*/
@Override
public double getYValue(int series, int item) {
VectorSeries s = (VectorSeries) this.data.get(series);
VectorDataItem di = (VectorDataItem) s.getDataItem(item);
return di.getYValue();
}
/**
* Returns the y-value for an item within a series. Note that this method
* creates a new {@link Double} instance every time it is called---use
* {@link #getYValue(int, int)} instead, if possible.
*
* @param series the series index.
* @param item the item index.
*
* @return The y-value.
*/
@Override
public Number getY(int series, int item) {
return new Double(getYValue(series, item));
}
/**
* Returns the vector for an item in a series.
*
* @param series the series index.
* @param item the item index.
*
* @return The vector (possibly null).
*/
@Override
public Vector getVector(int series, int item) {
VectorSeries s = (VectorSeries) this.data.get(series);
VectorDataItem di = (VectorDataItem) s.getDataItem(item);
return di.getVector();
}
/**
* Returns the x-component of the vector for an item in a series.
*
* @param series the series index.
* @param item the item index.
*
* @return The x-component of the vector.
*/
@Override
public double getVectorXValue(int series, int item) {
VectorSeries s = (VectorSeries) this.data.get(series);
VectorDataItem di = (VectorDataItem) s.getDataItem(item);
return di.getVectorX();
}
/**
* Returns the y-component of the vector for an item in a series.
*
* @param series the series index.
* @param item the item index.
*
* @return The y-component of the vector.
*/
@Override
public double getVectorYValue(int series, int item) {
VectorSeries s = (VectorSeries) this.data.get(series);
VectorDataItem di = (VectorDataItem) s.getDataItem(item);
return di.getVectorY();
}
/**
* 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 VectorSeriesCollection)) {
return false;
}
VectorSeriesCollection that = (VectorSeriesCollection) obj;
return ObjectUtilities.equal(this.data, that.data);
}
/**
* Returns a clone of this instance.
*
* @return A clone.
*
* @throws CloneNotSupportedException if there is a problem.
*/
@Override
public Object clone() throws CloneNotSupportedException {
VectorSeriesCollection clone
= (VectorSeriesCollection) super.clone();
clone.data = (List) ObjectUtilities.deepClone(this.data);
return clone;
}
}