Package io.jmix.reportsflowui.runner

Class ReportPresentationRegistry

java.lang.Object

io.jmix.reportsflowui.runner.ReportPresentationRegistry

@Component("report_ReportPresentationRegistry")
public class ReportPresentationRegistry
extends Object

Registry of all ReportExecutionPresentation implementations available in the application context.

Used by the report runner to resolve how a specific output channel (download, spreadsheet viewer, table viewer, …) should prepare and display a report result.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ReportExecutionPresentation>	presentations
protected final Map<String,ReportExecutionPresentation>	presentationsById

Constructor Summary

Constructors

Constructor	Description
ReportPresentationRegistry()

Method Summary

Modifier and Type	Method	Description
void	applyPresentationDefaults(UiReportRunContext context)	Resolves the default template and output type for the presentation carried by the context and writes them back into the context's underlying run context.
protected UiReportRunContext	copyContext(UiReportRunContext sourceContext)
UiReportRunContext	createRunContext(UiReportRunContext sourceContext, String presentationId)	Wraps sourceContext in a PresentationUiReportRunContext targeting the given presentation.
ReportExecutionPresentation	getPresentation(UiReportRunContext context)
ReportExecutionPresentation	getPresentation(String presentationId)
boolean	hasPresentation(String presentationId)
protected void	init()
boolean	isPresentation(UiReportRunContext context, String presentationId)
protected boolean	shouldPreserveMissingDefaultTemplate(UiReportRunContext context, ReportExecutionPresentation presentation, @Nullable Report report)
boolean	supportsReport(@Nullable Report report, String presentationId)

Methods inherited from class java.lang.Object

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

Field Details

presentations

@Autowired
protected List<ReportExecutionPresentation> presentations

presentationsById

protected final Map<String,ReportExecutionPresentation> presentationsById

Constructor Details

ReportPresentationRegistry

public ReportPresentationRegistry()

Method Details

init

@PostConstruct
protected void init()

getPresentation

public ReportExecutionPresentation getPresentation(UiReportRunContext context)

Returns:

the presentation associated with the run context, falling back to ReportExecutionPresentationIds.DEFAULT when the context carries no explicit presentation

Throws:

IllegalArgumentException - if the resolved presentation id is not registered

getPresentation

public ReportExecutionPresentation getPresentation(String presentationId)

Returns:

the presentation registered under presentationId

Throws:

IllegalArgumentException - if no presentation with the given id is registered

hasPresentation

public boolean hasPresentation(String presentationId)

Returns:

true if a presentation with the given id is registered

supportsReport

public boolean supportsReport(@Nullable Report report,
 String presentationId)

Returns:

true if the presentation is registered and supports the report; false when the presentation is not registered

createRunContext

public UiReportRunContext createRunContext(UiReportRunContext sourceContext,
 String presentationId)

Wraps sourceContext in a PresentationUiReportRunContext targeting the given presentation. Returns the original context unchanged when the presentation is ReportExecutionPresentationIds.DEFAULT and the context is not already presentation-aware.

isPresentation

public boolean isPresentation(UiReportRunContext context,
 String presentationId)

Returns:

true if the run context targets the presentation identified by presentationId

applyPresentationDefaults

public void applyPresentationDefaults(UiReportRunContext context)

Resolves the default template and output type for the presentation carried by the context and writes them back into the context's underlying run context.

copyContext

protected UiReportRunContext copyContext(UiReportRunContext sourceContext)

shouldPreserveMissingDefaultTemplate

protected boolean shouldPreserveMissingDefaultTemplate(UiReportRunContext context,
 ReportExecutionPresentation presentation,
 @Nullable Report report)