io.jmix.reportsui.screen

Class ReportGuiManager

java.lang.Object

io.jmix.reportsui.screen.ReportGuiManager

@UIScope
 @Component(value="report_ReportGuiManager")
public class ReportGuiManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.CoreProperties	coreProperties
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected io.jmix.core.DataManager	dataManager
protected io.jmix.ui.Dialogs	dialogs
protected io.jmix.ui.download.Downloader	downloader
protected io.jmix.core.FetchPlans	fetchPlans
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected ReportsClientProperties	reportingClientConfig
protected Reports	reports
protected ReportSecurityManager	reportSecurityManager
protected io.jmix.ui.ScreenBuilders	screenBuilders
protected io.jmix.ui.Screens	screens
protected io.jmix.ui.UiProperties	uiProperties

Constructor Summary

Constructors

Constructor and Description
ReportGuiManager()

Method Summary

Modifier and Type	Method and Description
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, io.jmix.ui.screen.FrameOwner screen, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
boolean	containsAlterableTemplate(Report report)
protected java.lang.Object	convertParameterIfNecessary(ReportInputParameter parameter, java.lang.Object paramValue, boolean useForInputParametersForm)
java.util.List<Report>	getAvailableReports(java.lang.String screenId, org.springframework.security.core.userdetails.UserDetails user, io.jmix.core.metamodel.model.MetaClass inputValueMetaClass) Return list of reports, available for certain screen, user and input parameter
protected Report	getReportForPrinting(Report report) Defensive copy
com.haulmont.yarg.reporting.ReportOutputDocument	getReportResult(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode) Generate ReportOutputDocument
com.haulmont.yarg.reporting.ReportOutputDocument	getReportResult(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, ReportOutputType outputType) Generate ReportOutputDocument
protected java.lang.Object	handleCollectionParameter(java.lang.Object paramValue, boolean convertToSingleItem)
boolean	inputParametersRequiredByTemplates(Report report)
protected void	openReportParamsDialog(io.jmix.ui.screen.FrameOwner screen, Report report, java.util.Map<java.lang.String,java.lang.Object> parameters, ReportInputParameter inputParameter, java.lang.String templateCode, java.lang.String outputFileName, boolean bulkPrint)
protected void	openReportParamsDialog(io.jmix.ui.screen.FrameOwner screen, Report report, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String templateCode, java.lang.String outputFileName)
boolean	parameterMatchesMetaClass(ReportInputParameter parameter, io.jmix.core.metamodel.model.MetaClass metaClass) Check if the meta class is applicable for the input parameter
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params) Print report synchronously
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, io.jmix.ui.screen.FrameOwner screen) Print report synchronously or asynchronously, depending on configurations
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName) Print report synchronously
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, io.jmix.ui.screen.FrameOwner screen) Print report synchronously or asynchronously, depending on configurations
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, io.jmix.ui.screen.FrameOwner screen) Print report synchronously or asynchronously, depending on configurations
void	printReportBackground(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, io.jmix.ui.screen.FrameOwner screen) Print report in background task with window, supports cancel
void	printReportBackground(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, io.jmix.ui.screen.FrameOwner screen) Print report in background task with window, supports cancel
void	printReportSync(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, io.jmix.ui.screen.FrameOwner screen) Print report synchronously
void	printReportSync(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, io.jmix.ui.screen.FrameOwner screen) Print report synchronously
void	runReport(Report report, io.jmix.ui.screen.FrameOwner screen) Open input parameters dialog if report has parameters otherwise print report
void	runReport(Report report, io.jmix.ui.screen.FrameOwner screen, ReportInputParameter parameter, java.lang.Object parameterValue, java.lang.String templateCode, java.lang.String outputFileName) Open input parameters dialog if report has parameters otherwise print report.
protected void	showReportResult(com.haulmont.yarg.reporting.ReportOutputDocument document, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, io.jmix.ui.screen.FrameOwner screen)
protected void	showReportResult(com.haulmont.yarg.reporting.ReportOutputDocument document, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, io.jmix.ui.screen.FrameOwner screen)
boolean	supportAlterableForTemplate(ReportTemplate template)

Methods inherited from class java.lang.Object

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

Field Detail

reports

@Autowired
protected Reports reports

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

messages

@Autowired
protected io.jmix.core.Messages messages

metadata

@Autowired
protected io.jmix.core.Metadata metadata

reportSecurityManager

@Autowired
protected ReportSecurityManager reportSecurityManager

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

uiProperties

@Autowired
protected io.jmix.ui.UiProperties uiProperties

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

downloader

@Autowired
protected io.jmix.ui.download.Downloader downloader

reportingClientConfig

@Autowired
protected ReportsClientProperties reportingClientConfig

fetchPlans

@Autowired
protected io.jmix.core.FetchPlans fetchPlans

screenBuilders

@Autowired
protected io.jmix.ui.ScreenBuilders screenBuilders

screens

@Autowired
protected io.jmix.ui.Screens screens

dialogs

@Autowired
protected io.jmix.ui.Dialogs dialogs

currentAuthentication

@Autowired
protected io.jmix.core.security.CurrentAuthentication currentAuthentication

Constructor Detail

ReportGuiManager

public ReportGuiManager()

Method Detail

runReport

public void runReport(Report report,
                      io.jmix.ui.screen.FrameOwner screen)

Open input parameters dialog if report has parameters otherwise print report

Parameters:

report - - target report

screen - - caller window

runReport

public void runReport(Report report,
                      io.jmix.ui.screen.FrameOwner screen,
                      ReportInputParameter parameter,
                      java.lang.Object parameterValue,
                      @Nullable
                      java.lang.String templateCode,
                      @Nullable
                      java.lang.String outputFileName)

Open input parameters dialog if report has parameters otherwise print report. The method allows to select target template code, pass single parameter to report, and set output file name.

Parameters:

report - target report

screen - caller window

parameter - input parameter linked with passed parameter value

parameterValue - parameter value

templateCode - target template code

outputFileName - name for output file

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        io.jmix.ui.screen.FrameOwner screen)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

screen - - caller window

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName,
                        @Nullable
                        io.jmix.ui.screen.FrameOwner screen)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

screen - - caller window

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName,
                        @Nullable
                        ReportOutputType outputType,
                        io.jmix.ui.screen.FrameOwner screen)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

screen - - caller window

printReportSync

public void printReportSync(Report report,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            @Nullable
                            java.lang.String templateCode,
                            @Nullable
                            java.lang.String outputFileName,
                            @Nullable
                            io.jmix.ui.screen.FrameOwner screen)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

screen - - caller window

printReportSync

public void printReportSync(Report report,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            @Nullable
                            java.lang.String templateCode,
                            @Nullable
                            java.lang.String outputFileName,
                            @Nullable
                            ReportOutputType outputType,
                            @Nullable
                            io.jmix.ui.screen.FrameOwner screen)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

screen - - caller window

getReportResult

public com.haulmont.yarg.reporting.ReportOutputDocument getReportResult(Report report,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        @Nullable
                                                                        java.lang.String templateCode)

Generate ReportOutputDocument

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

Returns:

resulting ReportOutputDocument

getReportResult

public com.haulmont.yarg.reporting.ReportOutputDocument getReportResult(Report report,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        @Nullable
                                                                        java.lang.String templateCode,
                                                                        @Nullable
                                                                        ReportOutputType outputType)

Generate ReportOutputDocument

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputType - - target output type

Returns:

resulting ReportOutputDocument

showReportResult

protected void showReportResult(com.haulmont.yarg.reporting.ReportOutputDocument document,
                                java.util.Map<java.lang.String,java.lang.Object> params,
                                @Nullable
                                java.lang.String templateCode,
                                @Nullable
                                java.lang.String outputFileName,
                                @Nullable
                                io.jmix.ui.screen.FrameOwner screen)

showReportResult

protected void showReportResult(com.haulmont.yarg.reporting.ReportOutputDocument document,
                                java.util.Map<java.lang.String,java.lang.Object> params,
                                @Nullable
                                java.lang.String templateCode,
                                @Nullable
                                java.lang.String outputFileName,
                                @Nullable
                                ReportOutputType outputType,
                                @Nullable
                                io.jmix.ui.screen.FrameOwner screen)

printReportBackground

public void printReportBackground(Report report,
                                  java.util.Map<java.lang.String,java.lang.Object> params,
                                  @Nullable
                                  java.lang.String templateCode,
                                  @Nullable
                                  java.lang.String outputFileName,
                                  io.jmix.ui.screen.FrameOwner screen)

Print report in background task with window, supports cancel

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

screen - - caller window

printReportBackground

public void printReportBackground(Report report,
                                  java.util.Map<java.lang.String,java.lang.Object> params,
                                  @Nullable
                                  java.lang.String templateCode,
                                  @Nullable
                                  java.lang.String outputFileName,
                                  @Nullable
                                  ReportOutputType outputType,
                                  io.jmix.ui.screen.FrameOwner screen)

Print report in background task with window, supports cancel

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

screen - - caller window

getAvailableReports

public java.util.List<Report> getAvailableReports(@Nullable
                                                  java.lang.String screenId,
                                                  @Nullable
                                                  org.springframework.security.core.userdetails.UserDetails user,
                                                  @Nullable
                                                  io.jmix.core.metamodel.model.MetaClass inputValueMetaClass)

Return list of reports, available for certain screen, user and input parameter

Parameters:

screenId - - id of the screen

user - - caller user

inputValueMetaClass - - meta class of report input parameter

bulkPrint

public void bulkPrint(Report report,
                      @Nullable
                      java.lang.String templateCode,
                      @Nullable
                      ReportOutputType outputType,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      io.jmix.ui.screen.FrameOwner screen,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

screen - - caller window

additionalParameters - - user-defined parameters

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      io.jmix.ui.screen.FrameOwner screen,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - target report

alias - parameter alias

selectedEntities - list of selected entities

screen - caller window

additionalParameters - user-defined parameters

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      io.jmix.ui.screen.FrameOwner screen)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as inputParameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

alias - - inputParameter alias

selectedEntities - - list of selected entities

screen - - caller window

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

bulkPrintSync

public void bulkPrintSync(Report report,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          io.jmix.ui.screen.FrameOwner screen,
                          java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

screen - - caller window

additionalParameters - - user-defined parameters

bulkPrintSync

public void bulkPrintSync(Report report,
                          @Nullable
                          java.lang.String templateCode,
                          @Nullable
                          ReportOutputType outputType,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          io.jmix.ui.screen.FrameOwner screen,
                          java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

screen - - caller window

additionalParameters - - user-defined parameters

bulkPrintSync

public void bulkPrintSync(Report report,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          io.jmix.ui.screen.FrameOwner screen)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as inputParameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - inputParameter alias

selectedEntities - - list of selected entities

screen - - caller window

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                io.jmix.ui.screen.FrameOwner window,
                                java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                @Nullable
                                java.lang.String templateCode,
                                @Nullable
                                ReportOutputType outputType,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                io.jmix.ui.screen.FrameOwner screen,
                                java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

screen - - caller window

additionalParameters - - user-defined parameters

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                io.jmix.ui.screen.FrameOwner screen)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

screen - - caller window

parameterMatchesMetaClass

public boolean parameterMatchesMetaClass(ReportInputParameter parameter,
                                         io.jmix.core.metamodel.model.MetaClass metaClass)

Check if the meta class is applicable for the input parameter

getReportForPrinting

protected Report getReportForPrinting(Report report)

Defensive copy

openReportParamsDialog

protected void openReportParamsDialog(io.jmix.ui.screen.FrameOwner screen,
                                      Report report,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.Object> parameters,
                                      @Nullable
                                      ReportInputParameter inputParameter,
                                      @Nullable
                                      java.lang.String templateCode,
                                      @Nullable
                                      java.lang.String outputFileName,
                                      boolean bulkPrint)

openReportParamsDialog

protected void openReportParamsDialog(io.jmix.ui.screen.FrameOwner screen,
                                      Report report,
                                      @Nullable
                                      java.util.Map<java.lang.String,java.lang.Object> parameters,
                                      @Nullable
                                      java.lang.String templateCode,
                                      @Nullable
                                      java.lang.String outputFileName)

convertParameterIfNecessary

@Nullable
protected java.lang.Object convertParameterIfNecessary(ReportInputParameter parameter,
                                                                 @Nullable
                                                                 java.lang.Object paramValue,
                                                                 boolean useForInputParametersForm)

handleCollectionParameter

@Nullable
protected java.lang.Object handleCollectionParameter(@Nullable
                                                               java.lang.Object paramValue,
                                                               boolean convertToSingleItem)

inputParametersRequiredByTemplates

public boolean inputParametersRequiredByTemplates(Report report)

containsAlterableTemplate

public boolean containsAlterableTemplate(Report report)

supportAlterableForTemplate

public boolean supportAlterableForTemplate(ReportTemplate template)