org.pentaho.platform.uifoundation.chart
Class FlashChartHelper

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

public class FlashChartHelper
extends Object

This class provides wrapper functions to make it easier to generate flash charts within a dashboard environment.

Constructor Summary

FlashChartHelper()

Method Summary

static boolean	doFlashChart(String solutionName, String actionPath, String chartName, IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) doFlashChart generates a flash media player chart.
static boolean	doFlashDial(String solutionName, String actionPath, String actionName, IParameterProvider parameterProvider, StringBuffer outputStream, IPentahoSession userSession, ArrayList messages, ILogger logger) doFlashDial generates a flash media player dial.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlashChartHelper

public FlashChartHelper()

Method Detail

doFlashChart

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

doFlashChart generates a flash media player chart. It provides a simple wrapper around the org.pentaho.platform.chart.FlashChartComponent

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

doFlashDial

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

doFlashDial generates a flash media player dial. It provides a simple wrapper around the org.pentaho.platform.chart.FlashChartComponent

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