Class DefaultChartBeansGenerator
- java.lang.Object
-
- org.pentaho.platform.plugin.action.chartbeans.DefaultChartBeansGenerator
-
- All Implemented Interfaces:
IChartBeansGenerator
public class DefaultChartBeansGenerator extends Object implements IChartBeansGenerator
-
-
Constructor Summary
Constructors Constructor Description DefaultChartBeansGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
buildEmptyOpenFlashChartHtmlFragment(String msg)
String
buildJFreeChartHtmlFragment(File imageFile, String imageMap, String imageMapName, int chartWidth, int chartHeight, String contextPath)
String
buildOpenFlashChartHtmlFragment(String openFlashChartJson, String swfUrl, String chartWidth, String chartHeight)
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.protected org.pentaho.actionsequence.dom.ActionSequenceDocument
createActionSequenceDocument(Set<String> parameterNameSet, String contentLinkingTemplate)
Creates anActionSequenceDocument
that will run an MQL query and pipe the results in the ChartBeansChartComponent
.protected void
createAndRunActionSequence(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, Map<String,Object> params, Map<String,Object> defaultParameterMap, String contentLinkingTemplate, OutputStream out)
String
createChartAsHtml(org.pentaho.platform.api.engine.IPentahoSession userSession, Map<String,Object> parameterMap, String serializedChartDataDefinition, String serializedChartModel, int chartWidth, int chartHeight)
Convenience method that returns a complete HTML document containing the chart.String
createChartAsHtml(org.pentaho.platform.api.engine.IPentahoSession userSession, Map<String,Object> parameterMap, String serializedChartDataDefinition, String serializedChartModel, int chartWidth, int chartHeight, String contentLinkingTemplate)
String
getFlashObjectFragment()
String
getFlashScriptFragment()
String
getHtmlTemplate()
String
mergeJFreeChartHtmlTemplate(File imageFile, String imageMap, String imageMapName, int chartWidth, int chartHeight, String contextPath)
String
mergeOpenFlashChartHtmlTemplate(String openFlashChartJson, String swfUrl)
String
mergeStaticImageHtmlTemplate(String imageUrl)
protected void
runActionSequence(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.actionsequence.dom.ActionSequenceDocument doc)
Executes an action sequence from anActionSequenceDocument
.
-
-
-
Method Detail
-
createAndRunActionSequence
protected void createAndRunActionSequence(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, Map<String,Object> params, Map<String,Object> defaultParameterMap, String contentLinkingTemplate, OutputStream out)
-
runActionSequence
protected void runActionSequence(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.actionsequence.dom.ActionSequenceDocument doc) throws RuntimeException
Executes an action sequence from anActionSequenceDocument
.- Parameters:
pentahoSession
- currentIPentahoSession
parameterProviders
- map of parameter providers; there should a single entry with "request" as the keyoutputHandler
- output handlerdoc
- action sequence document- Throws:
RuntimeException
- if anything goes wrong
-
createActionSequenceDocument
protected org.pentaho.actionsequence.dom.ActionSequenceDocument createActionSequenceDocument(Set<String> parameterNameSet, String contentLinkingTemplate)
Creates anActionSequenceDocument
that will run an MQL query and pipe the results in the ChartBeansChartComponent
.- Parameters:
parameterNameSet
- set of parameter names that appear in the MQL query- Returns:
- doc
-
buildEmptyOpenFlashChartHtmlFragment
public String buildEmptyOpenFlashChartHtmlFragment(String msg)
- Specified by:
buildEmptyOpenFlashChartHtmlFragment
in interfaceIChartBeansGenerator
-
buildOpenFlashChartHtmlFragment
public String buildOpenFlashChartHtmlFragment(String openFlashChartJson, String swfUrl, String chartWidth, String chartHeight)
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).Only exposed for debugging (i.e. hosted mode) purposes.
- Specified by:
buildOpenFlashChartHtmlFragment
in interfaceIChartBeansGenerator
-
buildJFreeChartHtmlFragment
public String buildJFreeChartHtmlFragment(File imageFile, String imageMap, String imageMapName, int chartWidth, int chartHeight, String contextPath)
-
createChartAsHtml
public String createChartAsHtml(org.pentaho.platform.api.engine.IPentahoSession userSession, Map<String,Object> parameterMap, String serializedChartDataDefinition, String serializedChartModel, int chartWidth, int chartHeight, String contentLinkingTemplate) throws IOException
- Throws:
IOException
-
createChartAsHtml
public String createChartAsHtml(org.pentaho.platform.api.engine.IPentahoSession userSession, Map<String,Object> parameterMap, String serializedChartDataDefinition, String serializedChartModel, int chartWidth, int chartHeight) throws IOException
Description copied from interface:IChartBeansGenerator
Convenience method that returns a complete HTML document containing the chart. Resource references point back to the BI Server.- Specified by:
createChartAsHtml
in interfaceIChartBeansGenerator
- Throws:
IOException
-
mergeOpenFlashChartHtmlTemplate
public String mergeOpenFlashChartHtmlTemplate(String openFlashChartJson, String swfUrl)
- Specified by:
mergeOpenFlashChartHtmlTemplate
in interfaceIChartBeansGenerator
-
mergeJFreeChartHtmlTemplate
public String mergeJFreeChartHtmlTemplate(File imageFile, String imageMap, String imageMapName, int chartWidth, int chartHeight, String contextPath)
- Specified by:
mergeJFreeChartHtmlTemplate
in interfaceIChartBeansGenerator
-
mergeStaticImageHtmlTemplate
public String mergeStaticImageHtmlTemplate(String imageUrl)
- Specified by:
mergeStaticImageHtmlTemplate
in interfaceIChartBeansGenerator
-
getHtmlTemplate
public String getHtmlTemplate()
- Specified by:
getHtmlTemplate
in interfaceIChartBeansGenerator
-
getFlashScriptFragment
public String getFlashScriptFragment()
- Specified by:
getFlashScriptFragment
in interfaceIChartBeansGenerator
-
getFlashObjectFragment
public String getFlashObjectFragment()
- Specified by:
getFlashObjectFragment
in interfaceIChartBeansGenerator
-
-