org.pentaho.chart.plugin
Interface IChartPlugin

All Known Implementing Classes:

AbstractChartPlugin, JFreeChartPlugin, OpenFlashChartPlugin, XmlChartPlugin

public interface IChartPlugin

Author:

wseyler

Field Summary

static int	ERROR_DUPLICATE_SINGLETON
static int	ERROR_INDETERMINATE_CHART_TYPE
static int	ERROR_INVALID_DEFINITION
static int	ERROR_MISSING_REQUIRED_DATA
static int	RESULT_ERROR
static int	RESULT_VALIDATED

Method Summary

String	getPluginId()
Set<IOutput.OutputTypes>	getSupportedOutputs() Returns a set of OutputTypes that this plugin can return (via the IOutput returned from renderChartDocument).
IOutput	renderChartDocument(ChartDocumentContext chartDocumentContext, ChartTableModel data) Renders the chart based on the chartDocument and data.
IOutput	renderChartDocument(ChartModel chartDocumentContext, IChartDataModel data)
ChartResult	validateChartDocument(ChartDocument chartDocument) Validates the current chart document.

Field Detail

RESULT_VALIDATED

static final int RESULT_VALIDATED

See Also:

Constant Field Values

RESULT_ERROR

static final int RESULT_ERROR

See Also:

Constant Field Values

ERROR_MISSING_REQUIRED_DATA

static final int ERROR_MISSING_REQUIRED_DATA

See Also:

Constant Field Values

ERROR_INVALID_DEFINITION

static final int ERROR_INVALID_DEFINITION

See Also:

Constant Field Values

ERROR_DUPLICATE_SINGLETON

static final int ERROR_DUPLICATE_SINGLETON

See Also:

Constant Field Values

ERROR_INDETERMINATE_CHART_TYPE

static final int ERROR_INDETERMINATE_CHART_TYPE

See Also:

Constant Field Values

Method Detail

getPluginId

String getPluginId()

validateChartDocument

ChartResult validateChartDocument(ChartDocument chartDocument)

Validates the current chart document. AbstractChartPlugin implements the validations that are NOT plugin specific. The plugin should override and call the super before doing it's validation

Parameters:

chartDocument -

Returns:

renderChartDocument

IOutput renderChartDocument(ChartDocumentContext chartDocumentContext,
                            ChartTableModel data)

Renders the chart based on the chartDocument and data. Chart can be accessed via the output parameter which gets returned from this method call

Parameters:

chartDocument -

data -

Returns:

IOutput

renderChartDocument

IOutput renderChartDocument(ChartModel chartDocumentContext,
                            IChartDataModel data)

getSupportedOutputs

Set<IOutput.OutputTypes> getSupportedOutputs()

Returns a set of OutputTypes that this plugin can return (via the IOutput returned from renderChartDocument).

Returns: