|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.platform.plugin.action.chartbeans.ChartAction
public class ChartAction
This class was adapted from ChartComponent
by cboyden
This is a bean that permits easy access to the ChartBeans functionality and was
specifically designed to be run from within the Pentaho Platform as an Action Sequence
Action.
Constructor Summary | |
---|---|
ChartAction()
|
Method Summary | |
---|---|
void |
execute()
Called to process the chart definition and data set to produce a usable chart. |
String |
getChartEngine()
Get the chart engine that the resulting chart was created through |
boolean |
getConvertNullsToZero()
|
String |
getMimeType(String streamPropertyName)
Requests the mimetype of the content that the Action will write to the provided stream name. |
String |
getSwfName()
|
String |
getSwfPath()
|
void |
setCategoryColumn(String categoryCol)
Define the column in the data set that contains the Category data |
void |
setChartContentStream(OutputStream outStream)
Define the OutputStream to which the resulting chart shall be written |
void |
setChartData(org.pentaho.commons.connection.IPentahoResultSet chartDataSet)
Define the data set that will populate the chart |
void |
setChartEngine(String chartEngine)
Set the chart engine to render the chart |
void |
setChartHeight(int chartHeight)
Set the height of the chart in units specific to the ChartPlugin |
void |
setChartHeight(String chartHeight)
Set the height of the chart in units specific to the ChartPlugin |
void |
setChartModel(org.pentaho.chart.model.ChartModel chartModel)
Set the ChartModel |
void |
setChartModelJson(String chartModelJson)
Set the JSON representation of the ChartModel |
void |
setChartModelXml(String chartModelXml)
Set the XML representation of the ChartModel |
void |
setChartModelXmlStream(InputStream chartModelStream)
Set the XML representation of the ChartModel as an InputStream |
void |
setChartWidth(int chartWidth)
Set the width of the chart in units specific to the ChartPlugin |
void |
setChartWidth(String chartWidth)
Set the width of the chart in units specific to the ChartPlugin |
void |
setConvertNullsToZero(boolean convert)
|
void |
setOutputType(String outputType)
|
void |
setScalingFactor(Double scalingFactor)
|
void |
setSeriesColumn(String seriesCol)
Define the column in the data set that contains the Series/Domain data |
void |
setValueColumn(String valueCol)
Define the column in the data set that contains the Value/Range data |
void |
validate()
Validate the current settings of the ChartAction. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ChartAction()
Method Detail |
---|
public void execute() throws Exception
execute
in interface IAction
ChartBootException
ChartProcessingException
ResourceException
InvalidChartDefinition
IOException
PersistenceException
Exception
- if there was an error executing the ActionIAction.execute()
public void setChartContentStream(OutputStream outStream)
outStream
- Stream to receive the chartpublic void setChartData(org.pentaho.commons.connection.IPentahoResultSet chartDataSet)
chartDataSet
- data set for chartingpublic void validate() throws Exception
Exception
public void setSeriesColumn(String seriesCol)
seriesCol
- name of column that contains the Series/Domain for the chartpublic void setConvertNullsToZero(boolean convert)
public boolean getConvertNullsToZero()
public void setCategoryColumn(String categoryCol)
seriesCol
- name of column that contains the Category for the chartpublic void setValueColumn(String valueCol)
seriesCol
- name of column that contains the Value/Range for the chartpublic String getMimeType(String streamPropertyName)
IStreamingAction
getMimeType
in interface IStreamingAction
streamPropertyName
- the action definition output name representing
the streamed output, e.g. "reportContent"
public void setChartModelJson(String chartModelJson)
chartModelJson
- JSON serialized representation of the ChartModelpublic void setChartModelXmlStream(InputStream chartModelStream) throws IOException
chartModelStream
- XML serialized representation of the ChartModel
IOException
- if there is a problem converting the input stream to an encoded stringpublic void setChartModelXml(String chartModelXml)
chartStyleXml
- XML serialized representation of the ChartModelpublic void setChartModel(org.pentaho.chart.model.ChartModel chartModel)
chartModel
- model of the chart to be generatedpublic void setChartWidth(int chartWidth)
chartWidth
- width of the chartpublic void setChartHeight(int chartHeight)
chartHeight
- height of the chartpublic void setChartWidth(String chartWidth)
chartWidth
- width of the chartpublic void setChartHeight(String chartHeight)
chartHeight
- height of the chartpublic String getChartEngine()
public void setChartEngine(String chartEngine)
chartEngine
- Value of "JFreeChart" or "OpenFlashChart"public void setOutputType(String outputType)
public void setScalingFactor(Double scalingFactor)
public String getSwfPath()
public String getSwfName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |