/*
* org.openmicroscopy.shoola.util.ui.graphutils.ScatterPlot
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2007 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.util.ui.graphutils;
//Java imports
import java.awt.Color;
import java.awt.Shape;
import java.awt.geom.Ellipse2D;
import java.util.ArrayList;
import java.util.List;
//Third-party libraries
import org.jfree.chart.JFreeChart;
import org.jfree.chart.plot.XYPlot;
import org.jfree.data.xy.DefaultXYDataset;
//Application-internal dependencies
/**
* Displays a scatter plot using <code>JfreeChart</code>.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since OME3.0
*/
public class ScatterPlot
extends ChartObject
{
/**
* Default size for a shape to be created if no shape parameters supplied in
* constructor.
*/
private final static int SHAPESIZE = 3;
/** The dataset for the line plot. */
private DefaultXYDataset dataset;
/** The x, y data of the plot. */
private List<double[][]> data;
/** The shapes associated with each point in the plot. */
private List<Shape> shapes;
/** Initializes. */
private void initialize()
{
data = new ArrayList<double[][]>();
shapes = new ArrayList<Shape>();
dataset = new DefaultXYDataset();
}
/**
* Creates the default shape if no shape param was passed in constuctor.
*
* @return See above.
*/
private Ellipse2D createDefaultShape()
{
return new Ellipse2D.Double(-SHAPESIZE, -SHAPESIZE,
SHAPESIZE, SHAPESIZE);
}
/** Creates a new instance. */
public ScatterPlot()
{
super("");
initialize();
}
/**
* Creates a new instance.
*
* @param title The title of the graph.
* @param newLegends The legends of each series.
* @param newData The data for each series.
* @param newColours The colours for each series.
* @param newShapes The shapes for each series..
*/
public ScatterPlot(String title, List<String> newLegends,
List<double[][]> newData, List<Color> newColours,
List<Shape> newShapes)
{
super(title);
if (newLegends == null || newData == null || newColours == null||
newShapes == null || newLegends.size() != newData.size() &&
newLegends.size() != newColours.size() &&
newLegends.size() != newShapes.size())
throw new IllegalArgumentException("Mismatch between argument " +
"length");
initialize();
for (int i = 0 ; i < newLegends.size(); i++)
addSeries(newLegends.get(i), newData.get(i), newColours.get(i),
newShapes.get(i));
setDefaultAxis();
}
/**
* Creates a new instance.
*
* @param title The title of the graph.
* @param newLegends The legends of each series.
* @param newData The data for each series.
* @param newColours The colours for each series.
*/
public ScatterPlot(String title, List<String> newLegends,
List<double[][]> newData, List<Color> newColours)
{
super(title);
if (newLegends == null || newData == null || newColours == null||
newLegends.size() != newData.size() &&
newLegends.size() != newColours.size())
throw new IllegalArgumentException("Mismatch between argument " +
"length");
initialize();
for (int i = 0 ; i < newLegends.size(); i++)
addSeries(newLegends.get(i), newData.get(i), newColours.get(i));
setDefaultAxis();
}
/**
* Adds a new Series to the plot.
*
* @param legend The name of the new series.
* @param newData The data.
* @param color The colour of the series.
* @param shape The shape of the series.
* @return The total number of series in the plot, this also gives the id
* of the just added series.
*/
public int addSeries(String legend, double[][] newData, Color color,
Shape shape)
{
legends.add(legend);
data.add(newData);
colours.add(color);
shapes.add(shape);
dataset.addSeries(legend, newData);
return dataset.getSeriesCount();
}
/**
* Adds a new Series to the plot.
*
* @param legend The name of the new series.
* @param newData The data.
* @param color The colour of the series.
* @return The total number of series in the plot, this also gives the id
* of the just added series.
*/
public int addSeries(String legend, double[][] newData, Color color)
{
legends.add(legend);
data.add(newData);
colours.add(color);
shapes.add(createDefaultShape());
dataset.addSeries(legend, newData);
return dataset.getSeriesCount();
}
/**
* Creates the chart.
* @see ChartObject#createChar()
*/
void createChart()
{
PointRenderer renderer = new PointRenderer(colours, shapes);
XYPlot plot = new XYPlot(dataset, domainAxis, rangeAxis, renderer);
if (backgroundImage != null) {
plot.setRangeGridlinesVisible(false);
plot.setDomainGridlinesVisible(false);
plot.setBackgroundImage(backgroundImage);
}
chart = new JFreeChart(title, plot);
}
}