io.jmix.reportsui.runner

Class FluentUiReportRunner

java.lang.Object

io.jmix.reportsui.runner.FluentUiReportRunner

@Component(value="report_FluentUiReportRunner")
 @Scope(value="prototype")
public class FluentUiReportRunner
extends java.lang.Object

Class is used to run a report using various additional criteria:

• Report entity or report code
• ReportTemplate entity or template code: if none of these fields is set, the default template is used.
• Output type
• Output name pattern
• Input parameters
• Screen: screen or screen fragment from which the report runs
• Show a dialog to input the report parameters (defined by ParametersDialogShowMode)
• Run a report synchronously or in the background (by default, a report runs synchronously)

Use the UiReportRunner bean to obtain an instance of the FluentUiReportRunner.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.beans.factory.ObjectProvider<FluentReportRunner>	fluentReportRunners

Constructor Summary

Constructors

Constructor and Description
FluentUiReportRunner()

Method Summary

Modifier and Type	Method and Description
FluentUiReportRunner	addParam(java.lang.String alias, java.lang.Object value) Adds an input parameter to the parameter map.
UiReportRunContext	buildContext() Creates an instance of UiReportRunContext based on the parameters specified for the fluent runner.
FluentUiReportRunner	inBackground(io.jmix.ui.screen.FrameOwner originFrameOwner) Sets a property to run a report in the background.
FluentUiReportRunner	init(Report report)
FluentUiReportRunner	init(java.lang.String reportCode)
void	runAndShow() Builds a UiReportRunContext instance, runs a report using this run context and shows the result.
void	runMultipleReports(java.lang.String multiParamAlias, java.util.Collection multiParamValues) Builds a UiReportRunContext instance, runs a report for each object from the specified collection.
void	setUiReportRunner(UiReportRunner uiReportRunner)
FluentUiReportRunner	withOutputNamePattern(java.lang.String outputNamePattern) Sets a name pattern of an output document.
FluentUiReportRunner	withOutputType(ReportOutputType outputType) Sets a type of output document.
FluentUiReportRunner	withParametersDialogShowMode(ParametersDialogShowMode mode) Sets a mode to show a dialog to input the report parameter before report run.
FluentUiReportRunner	withParams(java.util.Map<java.lang.String,java.lang.Object> params) Sets a map with input parameters.
FluentUiReportRunner	withTemplate(ReportTemplate template) Sets a template that will be used to run a report.
FluentUiReportRunner	withTemplateCode(java.lang.String templateCode) Sets a code of template that will be used to run a report.

Methods inherited from class java.lang.Object

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

Field Detail

fluentReportRunners

@Autowired
protected org.springframework.beans.factory.ObjectProvider<FluentReportRunner> fluentReportRunners

Constructor Detail

FluentUiReportRunner

public FluentUiReportRunner()

Method Detail

setUiReportRunner

@Autowired
public void setUiReportRunner(UiReportRunner uiReportRunner)

init

public FluentUiReportRunner init(Report report)

init

public FluentUiReportRunner init(java.lang.String reportCode)

withParams

public FluentUiReportRunner withParams(java.util.Map<java.lang.String,java.lang.Object> params)

Sets a map with input parameters.

Parameters:

params - input parameters

Returns:

current instance of fluent runner

addParam

public FluentUiReportRunner addParam(java.lang.String alias,
                                     java.lang.Object value)

Adds an input parameter to the parameter map.

Parameters:

alias - parameter alias

value - parameter value

Returns:

current instance of fluent runner

withTemplateCode

public FluentUiReportRunner withTemplateCode(java.lang.String templateCode)

Sets a code of template that will be used to run a report.

Parameters:

templateCode - template code

Returns:

current instance of fluent runner

withTemplate

public FluentUiReportRunner withTemplate(ReportTemplate template)

Sets a template that will be used to run a report.

Parameters:

template - report template

Returns:

current instance of fluent runner

withOutputType

public FluentUiReportRunner withOutputType(ReportOutputType outputType)

Sets a type of output document.

Parameters:

outputType - type of output document.

Returns:

current instance of fluent runner

withOutputNamePattern

public FluentUiReportRunner withOutputNamePattern(@Nullable
                                                  java.lang.String outputNamePattern)

Sets a name pattern of an output document.

Parameters:

outputNamePattern - name pattern of an output document

Returns:

current instance of fluent runner

inBackground

public FluentUiReportRunner inBackground(io.jmix.ui.screen.FrameOwner originFrameOwner)

Sets a property to run a report in the background.

Parameters:

originFrameOwner - screen or screen fragment from which the report runs

Returns:

current instance of fluent runner

withParametersDialogShowMode

public FluentUiReportRunner withParametersDialogShowMode(ParametersDialogShowMode mode)

Sets a mode to show a dialog to input the report parameter before report run. If a mode is not specified, the ParametersDialogShowMode.IF_REQUIRED is used by default.

Parameters:

mode - mode to show a dialog to input the report parameter before report run

Returns:

current instance of fluent runner

buildContext

public UiReportRunContext buildContext()

Creates an instance of UiReportRunContext based on the parameters specified for the fluent runner.

Returns:

run context

runAndShow

public void runAndShow()

Builds a UiReportRunContext instance, runs a report using this run context and shows the result.

runMultipleReports

public void runMultipleReports(java.lang.String multiParamAlias,
                               java.util.Collection multiParamValues)

Builds a UiReportRunContext instance, runs a report for each object from the specified collection. Objects in the collection should have the same type as an input parameter with specified alias. If the report has other parameters besides the specified one, values for these parameters are copied for each report run. As result, the ZIP archive with executed reports is downloaded.

Parameters:

multiParamAlias - alias of the parameter for which a value from the collection is used for report execution

multiParamValues - collection of values