at.mug.iqm.commons.util.plot

Class PlotFactory

java.lang.Object

at.mug.iqm.commons.util.plot.PlotFactory

public final class PlotFactory
extends Object

This factory creates JFreeChart plots from a given data set, plot model or image.

This factory is extended by all supported plot types, which are enumerated in ChartType.

Author:

Philipp Kainz

Constructor Summary

Constructors

Constructor and Description
PlotFactory()

Method Summary

Modifier and Type	Method and Description
static org.jfree.chart.JFreeChart	createDefaultPlot(List<PlotModel> plotModels) This method creates a default X-Y-JFreeChart from a List of PlotModels.
static org.jfree.chart.JFreeChart	createDefaultPlot(PlotModel plotModel) This method creates a default X-Y-JFreeChart from a single PlotModel.
static org.jfree.chart.JFreeChart	createDefaultScatterXYPlot(List<PlotModel> plotModels) This method creates a JFreeChart from a PlotModel.
static HistogramChart	createHistogramPlot(javax.media.jai.Histogram histo, String histoTitle) Creates a histogram chart from a Histogram.
static org.jfree.chart.JFreeChart	createHistogramPlot(List<PlotModel> plotModels, String histoTitle) Creates a histogram chart from a list of PlotModels.
static org.jfree.chart.JFreeChart	createHistogramPlot(RenderedImage image, String histoTitle) Creates a histogram chart from a RenderedImage.
static org.jfree.chart.JFreeChart	createHistogramPlot(org.jfree.data.xy.XYDataset dataset, String histoTitle) Creates a histogram chart from a data set.
static org.jfree.chart.JFreeChart	createPlot(List<PlotModel> plotModels, ChartType type) This method creates a JFreeChart from a List of PlotModels.
static org.jfree.chart.JFreeChart	createThumbNailPlot(List<PlotModel> plotModels, boolean withAxes) This method creates a default X-Y-JFreeChart from a List of PlotModels.
static org.jfree.chart.JFreeChart	createXYLinePlot(List<PlotModel> plotModels) This method creates a JFreeChart from a PlotModel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlotFactory

public PlotFactory()

Method Detail

createDefaultPlot

public static org.jfree.chart.JFreeChart createDefaultPlot(PlotModel plotModel)
                                                    throws Exception

This method creates a default X-Y-JFreeChart from a single PlotModel.

This is merely a convenient wrapper method for createPlot(List, ChartType).

Parameters:

plotModel - the plot model

Returns:

a JFreeChart chart of the plot model, or null, if the parameter is null

Throws:

Exception - if any error occurs in the conversion

See Also:

createPlot(List, ChartType)

createThumbNailPlot

public static org.jfree.chart.JFreeChart createThumbNailPlot(List<PlotModel> plotModels,
                                                             boolean withAxes)
                                                      throws Exception

This method creates a default X-Y-JFreeChart from a List of PlotModels.

This is merely a convenient wrapper method for createPlot(List, ChartType).

Parameters:

plotModels - the plot models

withAxes - a flag whether or not the axes should be shown in the plot

Returns:

a JFreeChart chart of the plot model, or null, if the parameter is null or the list is empty

Throws:

Exception - if any error occurs in the conversion

See Also:

createPlot(List, ChartType)

createDefaultPlot

public static org.jfree.chart.JFreeChart createDefaultPlot(List<PlotModel> plotModels)
                                                    throws Exception

This method creates a default X-Y-JFreeChart from a List of PlotModels.

This is merely a convenient wrapper method for createPlot(List, ChartType).

Parameters:

plotModels - the plot models

Returns:

a JFreeChart chart of the plot model, or null, if the parameter is null or the list is empty

Throws:

Exception - if any error occurs in the conversion

See Also:

createPlot(List, ChartType)

createPlot

public static org.jfree.chart.JFreeChart createPlot(List<PlotModel> plotModels,
                                                    ChartType type)
                                             throws Exception

This method creates a JFreeChart from a List of PlotModels.

This is merely a convenient wrapper method for createXYLinePlot(List).

Parameters:

plotModels - the plot models

type - the ChartType of the chart, may be null, but then, a ChartType.DEFAULT type is constructed

Returns:

a JFreeChart chart of the plot model, or null, if the parameter is null or the list is empty

Throws:

IllegalArgumentException - if the argument is null or does not contain any elements

Exception

See Also:

createXYLinePlot(List)

createXYLinePlot

public static org.jfree.chart.JFreeChart createXYLinePlot(List<PlotModel> plotModels)
                                                   throws IllegalArgumentException

This method creates a JFreeChart from a PlotModel.

Parameters:

plotModels - the plot models

Returns:

a JFreeChart chart of the plot model, or null if the parameter is null

Throws:

Exception - if any error occurs in the conversion

IllegalArgumentException - if the argument is null or does not contain any elements

createDefaultScatterXYPlot

public static org.jfree.chart.JFreeChart createDefaultScatterXYPlot(List<PlotModel> plotModels)
                                                             throws IllegalArgumentException

This method creates a JFreeChart from a PlotModel.

Parameters:

plotModels - the plot models

Returns:

a JFreeChart chart of the plot model, or null if the parameter is null

Throws:

Exception - if any error occurs in the conversion

IllegalArgumentException - if the argument is null or does not contain any elements

createHistogramPlot

public static org.jfree.chart.JFreeChart createHistogramPlot(List<PlotModel> plotModels,
                                                             String histoTitle)

Creates a histogram chart from a list of PlotModels.

Parameters:

plotModels - the list of PlotModels

histoTitle - the title of the histogram

Returns:

A chart.

createHistogramPlot

public static HistogramChart createHistogramPlot(javax.media.jai.Histogram histo,
                                                 String histoTitle)

Creates a histogram chart from a Histogram.

Parameters:

histo - the histogram

histoTitle - the title of the histogram

Returns:

A chart.

createHistogramPlot

public static org.jfree.chart.JFreeChart createHistogramPlot(RenderedImage image,
                                                             String histoTitle)

Creates a histogram chart from a RenderedImage.

Parameters:

image - the image

histoTitle - the title of the histogram

Returns:

A chart.

createHistogramPlot

public static org.jfree.chart.JFreeChart createHistogramPlot(org.jfree.data.xy.XYDataset dataset,
                                                             String histoTitle)

Creates a histogram chart from a data set.

Parameters:

dataset - a dataset.

Returns:

A chart.