org.gephi.ui.utils

Class ChartsUtils

java.lang.Object

org.gephi.ui.utils.ChartsUtils

public class ChartsUtils
extends Object

Utils class to build and change charts. Scatter plots implemented to be able to draw or not lines and linear regression.

Author:

Eduardo Ramos

Constructor Summary

Constructors

Constructor and Description
ChartsUtils()

Method Summary

Modifier and Type	Method and Description
static org.jfree.chart.JFreeChart	buildBoxPlot(Number[] numbers, String dataName) Build a new box-plot from an array of numbers using a default title and yLabel.
static org.jfree.chart.JFreeChart	buildHistogram(Number[] numbers, String dataName, int divisions) Build new histogram from the given numbers array using a default title and xLabel.
static org.jfree.chart.JFreeChart	buildScatterPlot(Number[] numbers, String dataName, boolean useLines, boolean useLinearRegression) Build new scatter plot from numbers array using a default title and xLabel.
static org.jfree.chart.JFreeChart	buildScatterPlot(org.jfree.data.xy.XYSeriesCollection data, String title, String xLabel, String yLabel, boolean useLines, boolean useLinearRegression) Build new Scatter plot.
private static String	getMessage(String resName)
static String	getStatisticsReportHTML(String dataName, BigDecimal[] statistics, org.jfree.chart.JFreeChart boxPlot, org.jfree.chart.JFreeChart scatterPlot, org.jfree.chart.JFreeChart histogram, Dimension boxPlotDimension, Dimension scatterPlotDimension, Dimension histogramDimension) Prepares a HTML report for the given statistics data and charts.
private static org.jfree.data.xy.XYDataset	regress(org.jfree.data.xy.XYSeriesCollection data) Calculates linear regression points from a XYSeriesCollection data set Code obtained from http://pwnt.be/2009/08/17/simple-linear-regression-with-jfreechart
static void	setScatterPlotLinearRegressionEnabled(org.jfree.chart.JFreeChart scatterPlot, boolean enabled) Modify a scatter plot to show linear regression or not.
static void	setScatterPlotLinesEnabled(org.jfree.chart.JFreeChart scatterPlot, boolean enabled) Modify a scatter plot to show lines instead or shapes or not.
private static void	writeBoxPlot(StringBuilder sb, org.jfree.chart.JFreeChart boxPlot, Dimension dimension)
private static void	writeChart(StringBuilder sb, org.jfree.chart.JFreeChart chart, Dimension dimension, String fileName)
private static void	writeHistogram(StringBuilder sb, org.jfree.chart.JFreeChart histogram, Dimension dimension)
private static void	writeScatterPlot(StringBuilder sb, org.jfree.chart.JFreeChart scatterPlot, Dimension dimension)
private static void	writeStatistic(StringBuilder sb, String resName, BigDecimal number)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartsUtils

public ChartsUtils()

Method Detail

getStatisticsReportHTML

public static String getStatisticsReportHTML(String dataName,
                                             BigDecimal[] statistics,
                                             org.jfree.chart.JFreeChart boxPlot,
                                             org.jfree.chart.JFreeChart scatterPlot,
                                             org.jfree.chart.JFreeChart histogram,
                                             Dimension boxPlotDimension,
                                             Dimension scatterPlotDimension,
                                             Dimension histogramDimension)

Prepares a HTML report for the given statistics data and charts. For preparing the statistics data see the method getAllStatistics of the StatisticsUtils class.

Parameters:

dataName - Name of the data

statistics - Statistics obtained from the method getAllStatistics of the StatisticsUtils class

boxPlot - Box-plot jfreechart or null

scatterPlot - Scatter-plot jfreechart or null

histogram - Histogram-plot jfreechart or null

boxPlotDimension - Dimension for the box-plot or null to use a default dimension

scatterPlotDimension - Dimension for the scatter plot or null to use a default dimension

histogramDimension - Dimension for the histogram or null to use a default dimension

Returns:

buildBoxPlot

public static org.jfree.chart.JFreeChart buildBoxPlot(Number[] numbers,
                                                      String dataName)

Build a new box-plot from an array of numbers using a default title and yLabel. String dataName will be used for xLabel.

Parameters:

numbers - Numbers for building box-plot

dataName - Name of the numbers data

Returns:

Prepared box-plot

buildScatterPlot

public static org.jfree.chart.JFreeChart buildScatterPlot(Number[] numbers,
                                                          String dataName,
                                                          boolean useLines,
                                                          boolean useLinearRegression)

Build new scatter plot from numbers array using a default title and xLabel. String dataName will be used for yLabel. Appearance can be changed later with the other methods of ChartsUtils.

Parameters:

numbers - Numbers for the scatter plot

dataName - Name of the numbers data

useLines - Indicates if lines have to be drawn instead of shapes

useLinearRegression - Indicates if the scatter plot has to have linear regreesion line drawn

Returns:

Scatter plot for the data and appearance options

buildScatterPlot

public static org.jfree.chart.JFreeChart buildScatterPlot(org.jfree.data.xy.XYSeriesCollection data,
                                                          String title,
                                                          String xLabel,
                                                          String yLabel,
                                                          boolean useLines,
                                                          boolean useLinearRegression)

Build new Scatter plot. Appearance can be changed later with the other methods of ChartsUtils.

Parameters:

data - Data for the plot

title - Title for the chart

xLabel - Text for x label

yLabel - Text for y label

useLines - Indicates if lines have to be drawn instead of shapes

useLinearRegression - Indicates if the scatter plot has to have linear regreesion line drawn

Returns:

Scatter plot for the data and appearance options

buildHistogram

public static org.jfree.chart.JFreeChart buildHistogram(Number[] numbers,
                                                        String dataName,
                                                        int divisions)

Build new histogram from the given numbers array using a default title and xLabel. String dataName will be used for yLabel.

Parameters:

numbers - Numbers for the histogram

dataName - Name of the numbers data

divisions - Divisions for the histogram

Returns:

Prepared histogram

setScatterPlotLinesEnabled

public static void setScatterPlotLinesEnabled(org.jfree.chart.JFreeChart scatterPlot,
                                              boolean enabled)

Modify a scatter plot to show lines instead or shapes or not.

Parameters:

scatterPlot - Scatter plot to modify

enabled - Indicates if lines have to be shown

setScatterPlotLinearRegressionEnabled

public static void setScatterPlotLinearRegressionEnabled(org.jfree.chart.JFreeChart scatterPlot,
                                                         boolean enabled)

Modify a scatter plot to show linear regression or not.

Parameters:

scatterPlot - Scatter plot to modify

enabled - Indicates if linear regression has to be shown

regress

private static org.jfree.data.xy.XYDataset regress(org.jfree.data.xy.XYSeriesCollection data)

Calculates linear regression points from a XYSeriesCollection data set Code obtained from http://pwnt.be/2009/08/17/simple-linear-regression-with-jfreechart

writeStatistic

private static void writeStatistic(StringBuilder sb,
                                   String resName,
                                   BigDecimal number)

writeBoxPlot

private static void writeBoxPlot(StringBuilder sb,
                                 org.jfree.chart.JFreeChart boxPlot,
                                 Dimension dimension)
                          throws IOException

Throws:

IOException

writeScatterPlot

private static void writeScatterPlot(StringBuilder sb,
                                     org.jfree.chart.JFreeChart scatterPlot,
                                     Dimension dimension)
                              throws IOException

Throws:

IOException

writeHistogram

private static void writeHistogram(StringBuilder sb,
                                   org.jfree.chart.JFreeChart histogram,
                                   Dimension dimension)
                            throws IOException

Throws:

IOException

writeChart

private static void writeChart(StringBuilder sb,
                               org.jfree.chart.JFreeChart chart,
                               Dimension dimension,
                               String fileName)
                        throws IOException

Throws:

IOException

getMessage

private static String getMessage(String resName)