ChartBeansGeneratorUtil.java

/*
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General
 * Public License, version 2.1 as published by the Free Software Foundation. You should have received a copy of the GNU
 * Lesser General Public License along with this program; if not, you can obtain a copy at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html or from the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA. 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 Lesser General Public License for more details. Copyright 2008 - 2009 Pentaho Corporation. All rights
 * reserved.
 */
package org.pentaho.platform.plugin.action.chartbeans;

import java.io.IOException;
import java.util.Map;

import org.pentaho.platform.api.engine.IPentahoSession;
import org.pentaho.platform.engine.core.system.PentahoSystem;

/**
 * Takes all inputs necessary to generate a chart and passes them to the ChartBeans engine (via an xaction).
 */
public class ChartBeansGeneratorUtil {

  private static IChartBeansGenerator generator; 
  
  static {
    IChartBeansGenerator gen = PentahoSystem.get(IChartBeansGenerator.class);
    
    // If we are not running the PentahoSystem, at least give us a default generator...
    if (gen == null){
      gen = new DefaultChartBeansGenerator();
    }
    generator = gen;
  }
  
  private ChartBeansGeneratorUtil() {
  }

  public static String createChartAsHtml(IPentahoSession userSession, Map<String, String> parameterMap, String serializedChartDataDefinition,
      String serializedChartModel, int chartWidth, int chartHeight) throws IOException {

    return generator.createChartAsHtml(userSession, parameterMap, serializedChartDataDefinition, serializedChartModel, chartWidth, chartHeight);
    
  }

  /**
   * Returns a complete HTML document that references a static image held in a temporary file on the server.
   * <p>
   * Only exposed for debugging (i.e. hosted mode) purposes.
   * </p>
   */
  public static String mergeStaticImageHtmlTemplate(String imageUrl) {
    return generator.mergeStaticImageHtmlTemplate(imageUrl);
  }

  /**
   * Does this method belong in ChartBeansGeneratorUtil? ChartBeansGeneratorUtil may be more of a convenience for
   * executing the default ActionSequence, if this is to hold true, this method probably needs a new home more central
   * to the ChartBeans code. Returns a complete HTML document that references an Open Flash Chart SWF resource that
   * resides on the server along with the data that should be displayed in the chart (via a JavaScript function that
   * returns a JSON string).
   * <p>
   * Only exposed for debugging (i.e. hosted mode) purposes.
   * </p>
   */
  public static String mergeOpenFlashChartHtmlTemplate(String openFlashChartJson, String swfUrl) {
    return generator.mergeOpenFlashChartHtmlTemplate(openFlashChartJson, swfUrl);
  }

  public static String buildEmptyOpenFlashChartHtmlFragment(String msg) {
    return generator.buildEmptyOpenFlashChartHtmlFragment(msg);
  }
  
}