use of org.pentaho.actionsequence.dom.IActionSequenceOutput in project pentaho-platform by pentaho.
the class DefaultChartBeansGenerator method createActionSequenceDocument.
/**
* Creates an <code>ActionSequenceDocument</code> that will run an MQL query and pipe the results in the ChartBeans
* <code>ChartComponent</code>.
*
* @param parameterNameSet
* set of parameter names that appear in the MQL query
* @return doc
*/
protected ActionSequenceDocument createActionSequenceDocument(final Set<String> parameterNameSet, String contentLinkingTemplate) {
ActionSequenceDocument actionSequenceDocument = new ActionSequenceDocument();
// $NON-NLS-1$
actionSequenceDocument.setTitle("chartbeans_mql.xaction");
// $NON-NLS-1$
actionSequenceDocument.setVersion("1");
// $NON-NLS-1$
actionSequenceDocument.setLoggingLevel("debug");
// $NON-NLS-1$
actionSequenceDocument.setAuthor("Dashboard");
// $NON-NLS-1$
actionSequenceDocument.setDescription("Generate a chart through ChartBeans from an MQL statement.");
actionSequenceDocument.setHelp(// $NON-NLS-1$
"Pass in an MQL statement that returns a table of three columns. The first column " + // $NON-NLS-1$
"is the series, the second is the category and the third is the data.");
// $NON-NLS-1$
actionSequenceDocument.setHelp("");
// $NON-NLS-1$
actionSequenceDocument.setResultType("rule");
// $NON-NLS-1$
IActionSequenceInput queryInput = actionSequenceDocument.createInput("query", IActionSequenceDocument.STRING_TYPE);
// $NON-NLS-1$
IActionSequenceInput chartModelJsonInput = actionSequenceDocument.createInput("chart-model-json", IActionSequenceDocument.STRING_TYPE);
// $NON-NLS-1$
IActionSequenceInput chartWidthInput = actionSequenceDocument.createInput("chart-width", IActionSequenceDocument.INTEGER_TYPE);
// $NON-NLS-1$
chartWidthInput.addSource(IActionSequenceDocument.REQUEST_INPUT_SOURCE, "chart-width");
// $NON-NLS-1$
chartWidthInput.setDefaultValue("1");
// $NON-NLS-1$
IActionSequenceInput chartHeightInput = actionSequenceDocument.createInput("chart-height", IActionSequenceDocument.INTEGER_TYPE);
// $NON-NLS-1$
chartHeightInput.addSource(IActionSequenceDocument.REQUEST_INPUT_SOURCE, "chart-height");
// $NON-NLS-1$
chartHeightInput.setDefaultValue("1");
// $NON-NLS-1$
IActionSequenceInput seriesColumnInput = actionSequenceDocument.createInput("series-column", IActionSequenceDocument.STRING_TYPE);
// $NON-NLS-1$
seriesColumnInput.setDefaultValue("1");
// $NON-NLS-1$
IActionSequenceInput categoryColumnInput = actionSequenceDocument.createInput("category-column", IActionSequenceDocument.STRING_TYPE);
// set a default value of empty string to avoid an error when rendering pie charts (which don't have a category
// column
// $NON-NLS-1$
categoryColumnInput.setDefaultValue("2");
// $NON-NLS-1$
IActionSequenceInput valueColumnInput = actionSequenceDocument.createInput("value-column", IActionSequenceDocument.STRING_TYPE);
// $NON-NLS-1$
valueColumnInput.setDefaultValue("0");
// $NON-NLS-1$
IActionSequenceInput scalingFactorInput = actionSequenceDocument.createInput("scaling-factor", IActionSequenceDocument.STRING_TYPE);
// add inputs from parameterNameSet; these parameters will appear as placeholders in the query input
for (String parameterName : parameterNameSet) {
IActionSequenceInput input = actionSequenceDocument.createInput(ActionDefinitionEncoder.encodeBlankSpaces(parameterName), IActionSequenceDocument.STRING_TYPE);
IActionSequenceInputSource[] sources = input.getSources();
if (sources.length > 0) {
input.getSources()[0].setName(parameterName);
} else {
input.addSource("request", parameterName);
}
}
// $NON-NLS-1$
IActionSequenceOutput outputStreamOutput = actionSequenceDocument.createOutput("outputstream", IActionSequenceDocument.CONTENT_TYPE);
// $NON-NLS-1$
outputStreamOutput.addDestination(IActionSequenceDocument.RESPONSE_OUTPUT_DESTINATION, "content");
MQLAction mqlAction = (MQLAction) actionSequenceDocument.addAction(MQLAction.class);
// $NON-NLS-1$
mqlAction.setActionInputValue("query", queryInput);
// add inputs from parameterNameSet to this action
for (String parameterName : parameterNameSet) {
mqlAction.addInput(ActionDefinitionEncoder.encodeBlankSpaces(parameterName), IActionSequenceDocument.STRING_TYPE);
}
// $NON-NLS-1$
mqlAction.setOutputResultSet("chartdata");
// $NON-NLS-1$
mqlAction.setComponentDefinition("live", Boolean.TRUE.toString());
// $NON-NLS-1$
mqlAction.setComponentDefinition("display-names", Boolean.FALSE.toString());
ActionDefinition pojoAction = (ActionDefinition) actionSequenceDocument.addAction(ActionDefinition.class);
// $NON-NLS-1$
pojoAction.setComponentName("ChartBeansComponent");
if (contentLinkingTemplate != null) {
pojoAction.setComponentDefinition("contentLinkingTemplate", contentLinkingTemplate);
}
// $NON-NLS-1$
pojoAction.setActionInputValue("chart-model-json", chartModelJsonInput);
// $NON-NLS-1$
pojoAction.addInput("chartdata", IActionSequenceDocument.RESULTSET_TYPE);
// $NON-NLS-1$
pojoAction.setActionInputValue("chart-width", chartWidthInput);
// $NON-NLS-1$
pojoAction.setActionInputValue("chart-height", chartHeightInput);
// $NON-NLS-1$
pojoAction.setActionInputValue("series-column", seriesColumnInput);
// $NON-NLS-1$
pojoAction.setActionInputValue("category-column", categoryColumnInput);
// $NON-NLS-1$
pojoAction.setActionInputValue("value-column", valueColumnInput);
// $NON-NLS-1$
pojoAction.setActionInputValue("scaling-factor", scalingFactorInput);
// $NON-NLS-1$
pojoAction.addOutput("outputstream", IActionSequenceDocument.CONTENT_TYPE);
return actionSequenceDocument;
}
use of org.pentaho.actionsequence.dom.IActionSequenceOutput in project pentaho-platform by pentaho.
the class ActionDelegate method hasPublicDestination.
/**
* This method will tell you if an output in the action definition references an output stream that has a
* global/public destination, such as "response", or "content". An action definition output is considered thusly,
* if it has a counterpart of the same name in the action sequence outputs AND that output is of type "content"
* AND it has declared one or more destinations.
*
* @param contentOutput
* the action definition output to check
* @return true if this output corresponds to a public destination-bound output
*/
protected boolean hasPublicDestination(IActionOutput contentOutput) {
String resolvedName = contentOutput.getPublicName();
IActionSequenceOutput publicOutput = getActionDefinition().getDocument().getOutput(resolvedName);
if (publicOutput == null) {
return false;
}
return (publicOutput.getType().equals(ActionSequenceDocument.CONTENT_TYPE) && publicOutput.getDestinations().length > 0);
}
Aggregations