org.pentaho.platform.plugin.action.openflashchart

Class OpenFlashChartComponent

java.lang.Object

org.pentaho.platform.engine.core.system.PentahoBase

org.pentaho.platform.engine.services.PentahoMessenger

org.pentaho.platform.engine.services.solution.ComponentBase

org.pentaho.platform.plugin.action.openflashchart.OpenFlashChartComponent

All Implemented Interfaces:

Serializable, org.pentaho.platform.api.engine.IAuditable, org.pentaho.platform.api.engine.IComponent, org.pentaho.platform.api.engine.ILogger, org.pentaho.platform.api.engine.IParameterResolver

public class OpenFlashChartComponent
extends org.pentaho.platform.engine.services.solution.ComponentBase

This component is a contribution from Nick Goodman and Tom Qin, it conforms to the ChartComponent API. Please see the wiki for details on this component. The component uses open-flash-chart-full-embedded-font.swf, found at http://www.ofc2dz.com/, which is a patched version of Open Flash Chart 2, found at http://teethgrinder.co.uk/open-flash-chart-2/ note: onclick events are only partially implemented, due to limitations of OFC. In future releases of OFC, this should be revisited. Backlog: - y2_legend - barline right axis title, would need to update OFC4J - horizontal stacked bars http://www.ofc2dz.com/OFC2/examples/HorizontalStackedBars.html - styled stacked bars (would require impl in OFC) - dial chart (would require impl in OFC) - XY Line Chart - XY Area Chart - onclick / link support (would require enhancements to OFC) - allow override of dataFunction name - review colors, move into config file for both jfree and ofc? - area stacked

Author:

Nick Goodman, Tom Qin, Will Gorman (wgorman@pentaho.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHART_NODE_LOC
protected org.pentaho.commons.connection.IPentahoResultSet	data
protected static String	flashFragment
protected String	template

Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

COMPONENT_EXECUTE_FAIL, debug, MISSING_SESSION, UNKNOWN_COMPONENT_ID

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

Constructors

Constructor and Description
OpenFlashChartComponent()

Method Summary

Modifier and Type	Method and Description
void	done()
protected boolean	executeAction()
protected String	generateChartJson(org.pentaho.commons.connection.IPentahoResultSet data, org.dom4j.Node chartNode, boolean byRow)
protected String	getFlashFragment()
protected String	getInputStringValue(String inputName)
protected Object	getInputValue(String inputName)
org.apache.commons.logging.Log	getLogger()
boolean	init()
void	inputMissingError(String paramName)
protected boolean	isDefinedInput(String inputName)
protected boolean	isDefinedResource(String resourceName)
protected boolean	validateAction()
boolean	validateSystemSettings()

Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase

addTempParameter, addTempParameterObject, applyInputsToFormat, audit, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, feedbackAllowed, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getContentOutputItem, getDefaultOutputStream, getFeedbackOutputStream, getId, getInitFailMessage, getInitOk, getInputBooleanValue, getInputLongValue, getInputNames, getInputParameter, getInputStream, getInputStringValue, getInstanceId, getLogId, getObjectName, getOutputContentItem, getOutputContentItem, getOutputItem, getOutputItem, getOutputNames, getOutputPreference, getProcessId, getResource, getResourceAsString, getResourceDataSource, getResourceInputStream, getResourceNames, getRuntimeContext, getSession, getSetting, getSolutionName, getSolutionPath, getStringSetting, isDefinedOutput, isPromptPending, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, saveSetting, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setFeedbackMimeType, setInstanceId, setOutputMimeType, setOutputMimeType, setOutputValue, setProcessId, setRuntimeContext, setSession, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.IComponent

getMessages, setMessages

Methods inherited from interface org.pentaho.platform.api.engine.ILogger

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Field Detail

CHART_NODE_LOC

public static String CHART_NODE_LOC

template

protected String template

data

protected org.pentaho.commons.connection.IPentahoResultSet data

flashFragment

protected static String flashFragment

Constructor Detail

OpenFlashChartComponent

public OpenFlashChartComponent()

Method Detail

validateAction

protected boolean validateAction()

Specified by:

validateAction in class org.pentaho.platform.engine.services.solution.ComponentBase

executeAction

protected boolean executeAction()

Specified by:

executeAction in class org.pentaho.platform.engine.services.solution.ComponentBase

generateChartJson

protected String generateChartJson(org.pentaho.commons.connection.IPentahoResultSet data,
                                   org.dom4j.Node chartNode,
                                   boolean byRow)

getFlashFragment

protected String getFlashFragment()

done

public void done()

Specified by:

done in interface org.pentaho.platform.api.engine.IComponent

Specified by:

done in class org.pentaho.platform.engine.services.solution.ComponentBase

init

public boolean init()

Specified by:

init in interface org.pentaho.platform.api.engine.IComponent

Specified by:

init in class org.pentaho.platform.engine.services.solution.ComponentBase

validateSystemSettings

public boolean validateSystemSettings()

Specified by:

validateSystemSettings in class org.pentaho.platform.engine.services.solution.ComponentBase

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class org.pentaho.platform.engine.core.system.PentahoBase

getInputValue

protected Object getInputValue(String inputName)

Overrides:

getInputValue in class org.pentaho.platform.engine.services.solution.ComponentBase

getInputStringValue

protected String getInputStringValue(String inputName)

Overrides:

getInputStringValue in class org.pentaho.platform.engine.services.solution.ComponentBase

isDefinedInput

protected boolean isDefinedInput(String inputName)

Overrides:

isDefinedInput in class org.pentaho.platform.engine.services.solution.ComponentBase

isDefinedResource

protected boolean isDefinedResource(String resourceName)

Overrides:

isDefinedResource in class org.pentaho.platform.engine.services.solution.ComponentBase

inputMissingError

public void inputMissingError(String paramName)

Overrides:

inputMissingError in class org.pentaho.platform.engine.services.solution.ComponentBase