Package io.jmix.reports.impl.repository

Class ReportRepositoryImpl

java.lang.Object

io.jmix.reports.impl.repository.ReportRepositoryImpl

All Implemented Interfaces:

ReportRepository

@Component("report_ReportRepository")
public class ReportRepositoryImpl
extends Object
implements ReportRepository

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportRepositoryImpl.FilteringContext

Field Summary

Fields

Modifier and Type	Field	Description
protected final AccessManager	accessManager
protected final AnnotatedReportHolder	annotatedReportHolder
protected final DataManager	dataManager
protected final EntityStates	entityStates
protected final Metadata	metadata
protected final MsgBundleTools	msgBundleTools
protected final AnnotatedReportScanner	reportScanner
protected final ReportSecurityManager	reportSecurityManager
protected final ReportsPersistence	reportsPersistence
protected final RepositoryUtil	repositoryUtil
protected final ResourceRoleRepository	resourceRoleRepository
protected final RoleAssignmentRepository	roleAssignmentRepository
static final String	RUN_FETCH_PLAN	Fetch plan enough to passing report to the running engine.

Constructor Summary

Constructors

Constructor

Description

ReportRepositoryImpl(AnnotatedReportHolder annotatedReportHolder, AnnotatedReportScanner reportScanner, DataManager dataManager, ReportsPersistence reportsPersistence, RepositoryUtil repositoryUtil, MsgBundleTools msgBundleTools, ReportSecurityManager reportSecurityManager, ResourceRoleRepository resourceRoleRepository, RoleAssignmentRepository roleAssignmentRepository, EntityStates entityStates, Metadata metadata, AccessManager accessManager)

Method Summary

Modifier and Type	Method	Description
boolean	existsReportByCode(String reportCode)	Checks if there are any reports with the given code.
boolean	existsReportByGroup(ReportGroup group)	Checks if any reports are connected to the given group.
Collection<Report>	getAllReports()	Load all known reports.
int	getTotalCount(ReportFilter filter)	Calculate total count of reports that conform to passed filter.
void	handleApplicationStartedEvent(org.springframework.boot.context.event.ApplicationStartedEvent event)
protected boolean	inputValueMetaClassSatisfies(Report report, MetaClass inputValueMetaClass, ReportRepositoryImpl.FilteringContext filteringContext)
protected boolean	isReadPermitted()
Report	loadForRunningByCode(String reportCode)	Load by code a full report object with all details, suitable for passing it to the rendering engine.
List<Report>	loadList(ReportLoadContext loadContext)	Load list of reports, with filtering, pagination and sorting options available.
Optional<UUID>	loadReportIdByCode(String reportCode)	Loads report id by its code.
protected List<Report>	loadReportsFromDatabase(ReportFilter filter)
protected boolean	outputTypeSatisfies(Report report, ReportOutputType outputType)
Report	reloadForRunning(Report report)
ReportTemplate	reloadTemplateForRunning(ReportTemplate template)
protected boolean	roleSatisfies(Report report, org.springframework.security.core.userdetails.UserDetails user, ReportRepositoryImpl.FilteringContext filteringContext)
Report	save(Report report)	Saves Report entity to the database.
protected boolean	viewIdSatisfies(Report report, String viewId)

Methods inherited from class java.lang.Object

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

Field Details

RUN_FETCH_PLAN

public static final String RUN_FETCH_PLAN

Fetch plan enough to passing report to the running engine.

See Also:

• Constant Field Values

annotatedReportHolder

protected final AnnotatedReportHolder annotatedReportHolder

reportScanner

protected final AnnotatedReportScanner reportScanner

dataManager

protected final DataManager dataManager

reportsPersistence

protected final ReportsPersistence reportsPersistence

repositoryUtil

protected final RepositoryUtil repositoryUtil

msgBundleTools

protected final MsgBundleTools msgBundleTools

reportSecurityManager

protected final ReportSecurityManager reportSecurityManager

resourceRoleRepository

protected final ResourceRoleRepository resourceRoleRepository

roleAssignmentRepository

protected final RoleAssignmentRepository roleAssignmentRepository

entityStates

protected final EntityStates entityStates

metadata

protected final Metadata metadata

accessManager

protected final AccessManager accessManager

Constructor Details

ReportRepositoryImpl

public ReportRepositoryImpl(AnnotatedReportHolder annotatedReportHolder,
 AnnotatedReportScanner reportScanner,
 DataManager dataManager,
 ReportsPersistence reportsPersistence,
 RepositoryUtil repositoryUtil,
 MsgBundleTools msgBundleTools,
 ReportSecurityManager reportSecurityManager,
 ResourceRoleRepository resourceRoleRepository,
 RoleAssignmentRepository roleAssignmentRepository,
 EntityStates entityStates,
 Metadata metadata,
 AccessManager accessManager)

Method Details

getAllReports

public Collection<Report> getAllReports()

Description copied from interface: ReportRepository

Load all known reports. Returned entities aren't guaranteed to have all internal structure loaded, only basic properties. When necessary, reload the entity using ReportRepository.reloadForRunning(Report) method.

Specified by:

getAllReports in interface ReportRepository

Returns:

list of reports with only basic properties loaded

loadList

public List<Report> loadList(ReportLoadContext loadContext)

Description copied from interface: ReportRepository

Load list of reports, with filtering, pagination and sorting options available. Returned entities aren't guaranteed to have all internal structure loaded, only basic properties. When necessary, reload the entity using ReportRepository.reloadForRunning(Report) method.

Specified by:

loadList in interface ReportRepository

Parameters:

loadContext - context containing filtering, pagination and sorting options

Returns:

list of reports with only basic properties loaded

viewIdSatisfies

protected boolean viewIdSatisfies(Report report,
 @Nullable
 String viewId)

roleSatisfies

protected boolean roleSatisfies(Report report,
 @Nullable
 org.springframework.security.core.userdetails.UserDetails user,
 ReportRepositoryImpl.FilteringContext filteringContext)

inputValueMetaClassSatisfies

protected boolean inputValueMetaClassSatisfies(Report report,
 @Nullable
 MetaClass inputValueMetaClass,
 ReportRepositoryImpl.FilteringContext filteringContext)

outputTypeSatisfies

protected boolean outputTypeSatisfies(Report report,
 @Nullable
 ReportOutputType outputType)

getTotalCount

public int getTotalCount(ReportFilter filter)

Description copied from interface: ReportRepository

Calculate total count of reports that conform to passed filter.

Specified by:

getTotalCount in interface ReportRepository

Parameters:

filter - object with filter values

Returns:

count of suitable reports

loadReportsFromDatabase

protected List<Report> loadReportsFromDatabase(ReportFilter filter)

loadForRunningByCode

@Nullable
public Report loadForRunningByCode(String reportCode)

Description copied from interface: ReportRepository

Load by code a full report object with all details, suitable for passing it to the rendering engine.

Specified by:

loadForRunningByCode in interface ReportRepository

Parameters:

reportCode - report's unique code

Returns:

full report object with all details, or null if no such report

existsReportByCode

public boolean existsReportByCode(String reportCode)

Description copied from interface: ReportRepository

Checks if there are any reports with the given code.

Specified by:

existsReportByCode in interface ReportRepository

Parameters:

reportCode - report code

Returns:

true if a report with this code exists, false otherwise

loadReportIdByCode

public Optional<UUID> loadReportIdByCode(String reportCode)

Description copied from interface: ReportRepository

Loads report id by its code.

Specified by:

loadReportIdByCode in interface ReportRepository

Parameters:

reportCode - report code.

Returns:

Optional id for report.

existsReportByGroup

public boolean existsReportByGroup(ReportGroup group)

Description copied from interface: ReportRepository

Checks if any reports are connected to the given group.

Specified by:

existsReportByGroup in interface ReportRepository

Parameters:

group - report group

Returns:

true if there is a report connected to this group, false otherwise

save

public Report save(Report report)

Description copied from interface: ReportRepository

Saves Report entity to the database.

Specified by:

save in interface ReportRepository

Parameters:

report - report entity instance

Returns:

saved instance

reloadForRunning

public Report reloadForRunning(Report report)

Specified by:

reloadForRunning in interface ReportRepository

reloadTemplateForRunning

public ReportTemplate reloadTemplateForRunning(ReportTemplate template)

Specified by:

reloadTemplateForRunning in interface ReportRepository

isReadPermitted

protected boolean isReadPermitted()

handleApplicationStartedEvent

@EventListener
public void handleApplicationStartedEvent(org.springframework.boot.context.event.ApplicationStartedEvent event)