Package io.jmix.reportsflowui.runner

Class TableReportExecutionPresentation

java.lang.Object

io.jmix.reportsflowui.runner.TableReportExecutionPresentation

All Implemented Interfaces:

ReportExecutionPresentation

@NullMarked
@Component("report_TableReportExecutionPresentation")
public class TableReportExecutionPresentation
extends Object
implements ReportExecutionPresentation

ReportExecutionPresentation that targets the in-dialog table viewer.

Supports only templates whose output type is ReportOutputType.TABLE.

Constructor Summary

Constructors

Constructor	Description
TableReportExecutionPresentation()

Method Summary

Modifier and Type	Method	Description
List<ReportOutputType>	getAvailableOutputTypes(@Nullable Report report, @Nullable ReportTemplate template)
List<ReportTemplate>	getAvailableTemplates(@Nullable Report report)
String	getId()
boolean	requiresUserChoice(@Nullable Report report, @Nullable ReportTemplate selectedTemplate, @Nullable ReportOutputType selectedOutputType)	A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.
@Nullable ReportOutputType	resolveDefaultOutputType(@Nullable Report report, @Nullable ReportTemplate template, @Nullable ReportOutputType selectedOutputType)	Resolves the output type to run the report with.
@Nullable ReportTemplate	resolveDefaultTemplate(@Nullable Report report, @Nullable ReportTemplate selectedTemplate)
boolean	supportsReport(@Nullable Report report)
protected boolean	supportsTemplate(@Nullable ReportTemplate template)

Methods inherited from class java.lang.Object

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

Constructor Details

TableReportExecutionPresentation

public TableReportExecutionPresentation()

Method Details

getId

public String getId()

Specified by:

getId in interface ReportExecutionPresentation

Returns:

ReportExecutionPresentationIds.TABLE

supportsReport

public boolean supportsReport(@Nullable Report report)

Specified by:

supportsReport in interface ReportExecutionPresentation

Returns:

true if the report has at least one template that produces table output

getAvailableTemplates

public List<ReportTemplate> getAvailableTemplates(@Nullable Report report)

Specified by:

getAvailableTemplates in interface ReportExecutionPresentation

Returns:

templates of the report whose output type is ReportOutputType.TABLE

resolveDefaultTemplate

public @Nullable ReportTemplate resolveDefaultTemplate(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate)

Specified by:

resolveDefaultTemplate in interface ReportExecutionPresentation

Returns:

the template to use by default, preferring selectedTemplate if it produces table output

getAvailableOutputTypes

public List<ReportOutputType> getAvailableOutputTypes(@Nullable Report report,
 @Nullable ReportTemplate template)

Specified by:

getAvailableOutputTypes in interface ReportExecutionPresentation

Returns:

an empty list — the table presentation does not support alterable output types

resolveDefaultOutputType

public @Nullable ReportOutputType resolveDefaultOutputType(@Nullable Report report,
 @Nullable ReportTemplate template,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

Resolves the output type to run the report with.

An explicitly requested selectedOutputType, e.g. the one set through the report runner API, must not be silently replaced: an implementation may return another type only if the requested one cannot be produced, either because this presentation is unable to render it or because the template cannot be converted to it. Restrictions on what the user is allowed to choose belong to ReportExecutionPresentation.getAvailableOutputTypes(Report, ReportTemplate) instead.

Specified by:

resolveDefaultOutputType in interface ReportExecutionPresentation

Returns:

ReportOutputType.TABLE if the template produces table output, null otherwise

requiresUserChoice

public boolean requiresUserChoice(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.

Specified by:

requiresUserChoice in interface ReportExecutionPresentation

Returns:

true if the report has more than one table-compatible template (the user must choose which template to use, even if a default was pre-filled)

supportsTemplate

protected boolean supportsTemplate(@Nullable ReportTemplate template)