org.pentaho.platform.uifoundation.chart
Class ChartHelper

java.lang.Object
  org.pentaho.platform.uifoundation.chart.ChartHelper

public class ChartHelper
extends Object

This class provides wrapper functions to make it easier to execute action sequences and generate a widget.

Constructor Summary

ChartHelper()

Method Summary

static boolean	doChart(String solutionName, String actionPath, String chartName, IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) doChart generates the images and html necessary to render various charts within a web page.
static boolean	doDial(String solutionName, String actionPath, String chartName, IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) Deprecated. use doChart() instead
static boolean	doPieChart(String solutionName, String actionPath, String chartName, IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) Deprecated. use doChart instead

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartHelper

public ChartHelper()

Method Detail

doChart

public static boolean doChart(String solutionName,
                              String actionPath,
                              String chartName,
                              IParameterProvider parameterProvider,
                              StringBuffer outputStream,
                              IPentahoSession userSession,
                              ArrayList messages,
                              ILogger logger)

doChart generates the images and html necessary to render various charts within a web page.

Parameters:

solutionName - the solution name

actionPath - the action path

chartName - the xml file describing the chart

parameterProvider - the collection of parameters to customize the chart

outputStream - the output string buffer for the content

userSession - the user session object

messages - a collection to store error and logging messages

logger - logging object

Returns:

true if successful

doPieChart

@Deprecated
public static boolean doPieChart(String solutionName,
                                            String actionPath,
                                            String chartName,
                                            IParameterProvider parameterProvider,
                                            StringBuffer outputStream,
                                            IPentahoSession userSession,
                                            ArrayList messages,
                                            ILogger logger)

Deprecated. use doChart instead

doPieChart generates the images and html necessary to render pie charts. It provides a simple wrapper around the class org.pentaho.ui.component.charting.PieDatasetChartComponent

Parameters:

solutionName - the solution name

actionPath - the action path

chartName - the xml file describing the chart

parameterProvider - the collection of parameters to customize the chart

outputStream - the output string buffer for the content

userSession - the user session object

messages - a collection to store error and logging messages

logger - logging object

Returns:

true if successful

doDial

@Deprecated
public static boolean doDial(String solutionName,
                                        String actionPath,
                                        String chartName,
                                        IParameterProvider parameterProvider,
                                        StringBuffer outputStream,
                                        IPentahoSession userSession,
                                        ArrayList messages,
                                        ILogger logger)

Deprecated. use doChart() instead

doDial generates the images and html necessary to render dials. It provides a simple wrapper around the class org.pentaho.ui.component.DashboardWidgetComponent

Parameters:

solutionName - the solution name

actionPath - the action path

chartName - the xml file describing the chart

parameterProvider - the collection of parameters to customize the chart

outputStream - the output string buffer for the content

userSession - the user session object

messages - a collection to store error and logging messages

logger - logging object

Returns:

true if successful