Package io.jmix.reportsflowui.runner.impl

Class RunSingleReportBackgroundTask

java.lang.Object

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

io.jmix.reportsflowui.runner.impl.RunSingleReportBackgroundTask

public class RunSingleReportBackgroundTask
extends BackgroundTask<Integer,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 UiReportRunContext	context
protected Messages	messages
protected Notifications	notifications
protected ReportRunner	reportRunner
protected Report	targetReport
protected UiReportRunnerSupport	uiReportRunnerSupport

Constructor Summary

Constructors

Constructor	Description
RunSingleReportBackgroundTask(long timeout, TimeUnit timeUnit, View<?> view, Report targetReport, ReportRunner runner, UiReportRunContext context)

Method Summary

Modifier and Type	Method	Description
void	canceled()	Called by the execution environment in UI thread if the task is canceled by BackgroundTaskHandler.cancel() invocation.
void	done(ReportOutputDocument document)	Called by the execution environment in UI thread when the task is completed.
boolean	handleException(Exception ex)	Called by the execution environment in UI thread if the task BackgroundTask.run(TaskLifeCycle) method raised an exception.
ReportOutputDocument	run(TaskLifeCycle<Integer> taskLifeCycle)	Main method that performs a task.
protected boolean	showErrorNotification(String text)

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

addProgressListener, getOwnerView, getParams, getProgressListeners, getTimeoutMilliseconds, getTimeoutSeconds, 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

messages

protected Messages messages

notifications

protected Notifications notifications

uiReportRunnerSupport

protected UiReportRunnerSupport uiReportRunnerSupport

targetReport

protected Report targetReport

context

protected UiReportRunContext context

Constructor Details

RunSingleReportBackgroundTask

public RunSingleReportBackgroundTask(long timeout,
 TimeUnit timeUnit,
 View<?> view,
 Report targetReport,
 ReportRunner runner,
 UiReportRunContext context)

Method Details

run

public 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,ReportOutputDocument>

Parameters:

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

Returns:

task result

handleException

public boolean handleException(Exception ex)

Description copied from class: BackgroundTask

Called by the execution environment in UI thread if the task BackgroundTask.run(TaskLifeCycle) method raised an exception.

Overrides:

handleException in class BackgroundTask<Integer,ReportOutputDocument>

Parameters:

ex - exception

Returns:

true if this method implementation actually handles the exception. Used for chaining handlers.

showErrorNotification

protected boolean showErrorNotification(String text)

done

public void done(ReportOutputDocument document)

Description copied from class: BackgroundTask

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

Overrides:

done in class BackgroundTask<Integer,ReportOutputDocument>

Parameters:

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

canceled

public void canceled()

Description copied from class: BackgroundTask

Called by the execution environment in UI thread if the task is canceled by BackgroundTaskHandler.cancel() invocation.
This method is not called in case of timeout expiration or owner view closing.

Overrides:

canceled in class BackgroundTask<Integer,ReportOutputDocument>