Package io.jmix.reportsflowui.runner.impl

Class RunMultipleReportsBackgroundTask

java.lang.Object

io.jmix.flowui.backgroundtask.BackgroundTask<Integer,List<ReportOutputDocument>>

io.jmix.reportsflowui.runner.impl.RunMultipleReportsBackgroundTask

public class RunMultipleReportsBackgroundTask
extends BackgroundTask<Integer,List<ReportOutputDocument>>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.backgroundtask.BackgroundTask

BackgroundTask.ProgressListener<T,V>, BackgroundTask.ProgressListenerAdapter<T,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final UiReportRunContext	context
protected Downloader	downloader
protected final String	multiParamAlias
protected final Collection<?>	multiParamValue
protected ReportRunner	reportRunner
protected ReportZipUtils	reportZipUtils
protected final Report	targetReport

Constructor Summary

Constructors

Constructor	Description
RunMultipleReportsBackgroundTask(UiReportRunContext context, long timeout, View<?> view, Report targetReport, String multiParamAlias, Collection<?> multiParamValue)

Method Summary

Modifier and Type	Method	Description
void	done(List<ReportOutputDocument> result)	Called by the execution environment in UI thread when the task is completed.
protected void	downloadZipArchive(List<ReportOutputDocument> outputDocuments)
protected List<ReportOutputDocument>	multiRunSync(UiReportRunContext uiReportRunContext, String multiParamName, Collection<?> multiParamValues)
List<ReportOutputDocument>	run(TaskLifeCycle<Integer> taskLifeCycle)	Main method that performs a task.
void	setDownloader(Downloader downloader)
void	setReportRunner(ReportRunner reportRunner)
void	setReportZipUtils(ReportZipUtils reportZipUtils)

Methods inherited from class io.jmix.flowui.backgroundtask.BackgroundTask

addProgressListener, canceled, getOwnerView, getParams, getProgressListeners, getTimeoutMilliseconds, getTimeoutSeconds, handleException, handleTimeoutException, progress, removeProgressListener

Methods inherited from class java.lang.Object

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

Field Details

reportRunner

protected ReportRunner reportRunner

reportZipUtils

protected ReportZipUtils reportZipUtils

downloader

protected Downloader downloader

context

protected final UiReportRunContext context

targetReport

protected final Report targetReport

multiParamAlias

protected final String multiParamAlias

multiParamValue

protected final Collection<?> multiParamValue

Constructor Details

RunMultipleReportsBackgroundTask

public RunMultipleReportsBackgroundTask(UiReportRunContext context,
 long timeout,
 View<?> view,
 Report targetReport,
 String multiParamAlias,
 Collection<?> multiParamValue)

Method Details

setReportZipUtils

@Autowired
public void setReportZipUtils(ReportZipUtils reportZipUtils)

setDownloader

@Autowired
public void setDownloader(Downloader downloader)

setReportRunner

@Autowired
public void setReportRunner(ReportRunner reportRunner)

run

public List<ReportOutputDocument> run(TaskLifeCycle<Integer> taskLifeCycle)

Description copied from class: BackgroundTask

Main method that performs a task.
Called by the execution environment in a separate working thread.
Implementation of this method should support interruption:

• In long loops check TaskLifeCycle.isInterrupted() and return if it is true
• Don't swallow InterruptedException - return from the method or don't catch it at all

Specified by:

run in class BackgroundTask<Integer,List<ReportOutputDocument>>

Parameters:

taskLifeCycle - lifecycle object that allows the main method to interact with the execution environment

Returns:

task result

done

public void done(List<ReportOutputDocument> result)

Description copied from class: BackgroundTask

Called by the execution environment in UI thread when the task is completed.

Overrides:

done in class BackgroundTask<Integer,List<ReportOutputDocument>>

Parameters:

result - result of execution returned by BackgroundTask.run(TaskLifeCycle) method

downloadZipArchive

protected void downloadZipArchive(List<ReportOutputDocument> outputDocuments)

multiRunSync

protected List<ReportOutputDocument> multiRunSync(UiReportRunContext uiReportRunContext,
 String multiParamName,
 Collection<?> multiParamValues)