| org.pentaho.plugin.ComponentBase
 org.pentaho.plugin.jasperreports.JasperReportsComponent
| JasperReportsComponent | | public class JasperReportsComponent extends ComponentBase (Code) | |
author:
James Dixon and Barry Klawans
author:
JasperReports runner for Pentaho.
author:
This class implements a Pentaho Component that runs JasperReports. It
author:
includes full support for parameterization and output in PDF and HTML.
author:
This is a Beta version, with a number of open issues. 1) Data sources must be
author:
specified in the config file for EACH report. There should be a default
author:
source in the jasper reports configuration. 2) Support for JNDI defined data
author:
source has not been added yet. 3) Images are written to the Pentaho temp
author:
directory and never cleaned up. They should probably be moved into Session
author:
related storage. 4) Support should be added so a Filled report can be
author:
persisited into the Pentaho repository and exported repeatedly.
author:
Radek Maciaszek
author:
Added handling multiple reports in batch mode which allow to create excel reports with
author:
multiple worksheets |
| Method Summary | |
| public void | done()
| | public boolean | executeAction()
Runs a report. | | public Log | getLogger()
| | public boolean | init()
| | public boolean | validateAction()
NOTE: The comments from Pentaho state that in production this will not be
called during execution. | | protected boolean | validateSystemSettings()
Validates the settings in the jasper reports configuration file. |
| COMPILED_JASPER_REPORTS_EXTENSION | | final public static String COMPILED_JASPER_REPORTS_EXTENSION(Code) | | The extension of a compiled JasperReports file.
|
| JASPER_REPORTS_DESIGN_EXTENSION | | final public static String JASPER_REPORTS_DESIGN_EXTENSION(Code) | | The extension of the JasperReports reports to run. Currently only designs
saved as an XML file are supported, not searilized JasperDesign objects.
|
| executeAction | | public boolean executeAction()(Code) | | Runs a report.
|
| getLogger | | public Log getLogger()(Code) | | |
| init | | public boolean init()(Code) | | |
| validateAction | | public boolean validateAction()(Code) | | NOTE: The comments from Pentaho state that in production this will not be
called during execution. If so, this info needs to be moved into the
execute path as well.
|
| validateSystemSettings | | protected boolean validateSystemSettings()(Code) | | Validates the settings in the jasper reports configuration file.
Currently the mandatory settings are imageHandling/imageUrl and
imageHandling/imageDir, which specify where to store images generated by
the report (ie charts) and how to access the images inside an HTML page.
|
| Methods inherited from org.pentaho.plugin.ComponentBase | protected void addTempParameter(String name, IActionParameter param)(Code)(Java Doc)
protected void addTempParameterObject(String name, Object paramObject)(Code)(Java Doc)
protected String applyInputsToFormat(String format)(Code)(Java Doc)
protected void audit(String messageType, String message, String value, int duration)(Code)(Java Doc)
protected void createFeedbackParameter(IActionParameter actionParam)(Code)(Java Doc)
protected void createFeedbackParameter(SelectionMapper selMap, String fieldName, Object defaultValues)(Code)(Java Doc)
protected void createFeedbackParameter(SelectionMapper selMap, String fieldName, Object defaultValues, boolean optional)(Code)(Java Doc)
protected void createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible)(Code)(Java Doc)
protected void createFeedbackParameter(String fieldName, String displayName, String hint, String defaultValue, boolean visible, boolean optional)(Code)(Java Doc)
public void createFeedbackParameter(String fieldName, String displayName, String hint, Object defaultValues, List values, Map dispNames, String displayStyle)(Code)(Java Doc)
public void createFeedbackParameter(String fieldName, String displayName, String hint, Object defaultValues, List values, Map dispNames, String displayStyle, boolean optional)(Code)(Java Doc)
public String createNewInstance(boolean persisted, Map parameters, boolean forceImmediateWrite)(Code)(Java Doc)
abstract public void done()(Code)(Java Doc)
public int execute()(Code)(Java Doc)
abstract protected boolean executeAction() throws Throwable(Code)(Java Doc)
protected boolean feedbackAllowed()(Code)(Java Doc)
public ActionDefinition getActionDefinition()(Code)(Java Doc)
public String getActionName()(Code)(Java Doc)
public String getActionTitle()(Code)(Java Doc)
public Node getComponentDefinition()(Code)(Java Doc)
public Node getComponentDefinition(boolean process)(Code)(Java Doc)
protected String getContentUrl(IContentItem contentItem)(Code)(Java Doc)
protected DataSource getDataSource(String parameterName)(Code)(Java Doc)
protected OutputStream getDefaultOutputStream(String mimeType)(Code)(Java Doc)
protected OutputStream getFeedbackOutputStream()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public String getInitFailMessage()(Code)(Java Doc)
public boolean getInitOk()(Code)(Java Doc)
protected boolean getInputBooleanValue(String inputName, boolean defaultValue)(Code)(Java Doc)
protected long getInputLongValue(String inputName, long defaultValue)(Code)(Java Doc)
protected Set getInputNames()(Code)(Java Doc)
protected IActionParameter getInputParameter(String parameterName)(Code)(Java Doc)
protected InputStream getInputStream(String inputName)(Code)(Java Doc)
protected String getInputStringValue(String inputName)(Code)(Java Doc)
protected String getInputStringValue(String inputName, boolean applyTemplates)(Code)(Java Doc)
protected Object getInputValue(String inputName)(Code)(Java Doc)
public String getInstanceId()(Code)(Java Doc)
public String getLogId()(Code)(Java Doc)
public String getObjectName()(Code)(Java Doc)
protected IContentItem getOutputContentItem(String mimeType)(Code)(Java Doc)
protected IContentItem getOutputContentItem(String outputName, String mimeType)(Code)(Java Doc)
protected IContentItem getOutputItem(String outputName, String mimeType, String extension)(Code)(Java Doc)
protected IActionParameter getOutputItem(String outputName)(Code)(Java Doc)
protected Set getOutputNames()(Code)(Java Doc)
protected int getOutputPreference()(Code)(Java Doc)
public String getProcessId()(Code)(Java Doc)
protected IActionResource getResource(String resourceName)(Code)(Java Doc)
public String getResourceAsString(IActionResource resource)(Code)(Java Doc)
protected DataSource getResourceDataSource(IActionResource resource) throws FileNotFoundException(Code)(Java Doc)
protected InputStream getResourceInputStream(IActionResource resource) throws FileNotFoundException(Code)(Java Doc)
protected Set getResourceNames()(Code)(Java Doc)
public IRuntimeContext getRuntimeContext()(Code)(Java Doc)
public IPentahoSession getSession()(Code)(Java Doc)
protected Object getSetting(String name)(Code)(Java Doc)
protected String getSolutionName()(Code)(Java Doc)
protected String getSolutionPath()(Code)(Java Doc)
protected String getStringSetting(String name)(Code)(Java Doc)
abstract public boolean init()(Code)(Java Doc)
public void inputMissingError(String paramName)(Code)(Java Doc)
protected boolean isDefinedInput(String inputName)(Code)(Java Doc)
protected boolean isDefinedOutput(String outputName)(Code)(Java Doc)
protected boolean isDefinedResource(String resourceName)(Code)(Java Doc)
protected boolean isPromptPending()(Code)(Java Doc)
public void outputMissingError(String paramName)(Code)(Java Doc)
public void promptNeeded()(Code)(Java Doc)
public void promptNow()(Code)(Java Doc)
public int resolveParameter(String template, String parameterName, Matcher parameterMatcher, int copyStart, StringBuffer result)(Code)(Java Doc)
public void resourceComponentSettingError(String paramName)(Code)(Java Doc)
public void resourceMissingError(String paramName)(Code)(Java Doc)
protected void saveSetting(String name, Object value)(Code)(Java Doc)
public void setActionDefinition(ActionDefinition actionDefinition)(Code)(Java Doc)
public void setActionName(String actionName)(Code)(Java Doc)
public void setComponentDefinition(Node componentDefinition)(Code)(Java Doc)
protected void setFeedbackMimeType(String mimeType)(Code)(Java Doc)
public void setInstanceId(String instanceId)(Code)(Java Doc)
protected void setOutputMimeType(String mimeType)(Code)(Java Doc)
protected void setOutputMimeType(String outputName, String mimeType)(Code)(Java Doc)
protected void setOutputValue(String outputName, Object value)(Code)(Java Doc)
public void setProcessId(String processId)(Code)(Java Doc)
public void setRuntimeContext(IRuntimeContext runtimeContext)(Code)(Java Doc)
public void setSession(IPentahoSession session)(Code)(Java Doc)
final public int validate()(Code)(Java Doc)
abstract protected boolean validateAction()(Code)(Java Doc)
abstract protected boolean validateSystemSettings()(Code)(Java Doc)
|
|
|