io.jmix.reportsui.screen.report.wizard

Class ReportsWizard

java.lang.Object

io.jmix.reportsui.screen.report.wizard.ReportsWizard

@Component(value="report_ReportsWizard")
public class ReportsWizard
extends java.lang.Object

API for report wizard

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSetFactory	dataSetFactory
protected static java.lang.String	DEFAULT_LIST_OF_ENTITIES_ALIAS
protected static java.lang.String	DEFAULT_SINGLE_ENTITY_ALIAS
protected javax.inject.Provider<EntityTreeModelBuilder>	entityTreeModelBuilderApiProvider
protected io.jmix.core.ExtendedEntities	extendedEntities
protected io.jmix.core.FetchPlans	fetchPlans
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected ReportsPersistence	reportsPersistence
protected ReportsProperties	reportsProperties
protected ReportsSerialization	reportsSerialization
protected ReportsUtils	reportsUtils
static java.lang.String	ROOT_BAND_DEFINITION_NAME
protected TemplateGenerator	templateGenerator

Constructor Summary

Constructors

Constructor and Description
ReportsWizard()

Method Summary

Modifier and Type	Method and Description
EntityTree	buildEntityTree(io.jmix.core.metamodel.model.MetaClass metaClass)
protected java.util.Set<BandDefinition>	createBands(Report report, BandDefinition rootReportBandDefinition, ReportData reportData, ReportInputParameter mainParameter)
protected BandDefinition	createDataBand(Report report, BandDefinition rootBandDefinition, java.lang.String name, int bandDefPos)
protected void	createDefaultFormats(Report report, ReportData reportData, ReportRegion reportRegion)
protected ReportTemplate	createDefaultTemplate(Report report, ReportData reportData)
protected void	createEntityDataSet(ReportData reportData, ReportRegion reportRegion, BandDefinition dataBand, ReportInputParameter mainParameter, io.jmix.core.FetchPlan parameterFetchPlan)
io.jmix.core.FetchPlan	createFetchPlanByReportRegions(EntityTreeNode entityTreeRootNode, java.util.List<ReportRegion> reportRegions)
protected BandDefinition	createHeaderBand(Report report, BandDefinition rootReportBandDefinition, int bandDefPos, ReportRegion reportRegion)
protected void	createJpqlDataSet(ReportData reportData, ReportRegion reportRegion, BandDefinition dataBand)
protected ReportInputParameter	createMainInputParameter(Report report, ReportData reportData)
protected ReportInputParameter	createParameter(Report report, int position)
protected ReportInputParameter	createParameters(ReportData reportData, Report report)
protected Report	createReport(ReportData reportData, boolean isTmp)
ReportRegion	createReportRegionByFetchPlan(EntityTree entityTree, boolean isTabulated, io.jmix.core.FetchPlan fetchPlan, java.lang.String collectionPropertyName) Create report region using fetch plan and whole entity model as entityTree param For creating tabulated report region for collection of entity (when used # in alias of dataset) fetch plan and parameters must to be non-nul values because otherwise necessary ReportRegion.regionPropertiesRootNode field value will be null.
protected BandDefinition	createRootBand(Report report)
protected io.jmix.core.FetchPlanBuilder	ensureParentFetchPlansExist(EntityTreeNode entityTreeNode, java.util.Map<EntityTreeNode,io.jmix.core.FetchPlanBuilder> fetchPlansForNodes) Search for fetch plan for parent node If does not exists - createDataSet it and add property to parent of parent fetch plan
byte[]	generateTemplate(ReportData reportData, TemplateFileType templateFileType)
protected java.util.List<java.lang.String>	getEffectiveEntities(java.util.List<java.lang.String> entitiesList)
protected io.jmix.core.metamodel.model.MetaClass	getOriginalMetaClass(io.jmix.core.metamodel.model.MetaClass metaClass)
protected java.util.List<java.lang.String>	getWizardBlackListedEntities()
protected java.util.List<java.lang.String>	getWizardBlackListedProperties()
protected java.util.List<java.lang.String>	getWizardPropertiesExcludedBlackList()
protected java.util.List<java.lang.String>	getWizardWhiteListedEntities()
boolean	isEntityAllowedForReportWizard(io.jmix.core.metamodel.model.MetaClass effectiveMetaClass)
boolean	isPropertyAllowedForReportWizard(io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.metamodel.model.MetaProperty metaProperty)
protected void	iterateFetchPlanAndCreatePropertiesForRegion(boolean scalarOnly, io.jmix.core.FetchPlan parentFetchPlan, java.util.Map<java.lang.String,EntityTreeNode> allNodesAndHierarchicalPathsMap, java.util.List<RegionProperty> regionProperties, java.lang.String pathFromParentFetchPlan, long propertyOrderNum)
protected void	nodesToMap(EntityTreeNode node, java.util.Map<java.lang.String,EntityTreeNode> allNodesAndHierarchicalPathsMap)
Report	toReport(ReportData reportData, boolean temporary)

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_BAND_DEFINITION_NAME

public static final java.lang.String ROOT_BAND_DEFINITION_NAME

See Also:

Constant Field Values

DEFAULT_SINGLE_ENTITY_ALIAS

protected static final java.lang.String DEFAULT_SINGLE_ENTITY_ALIAS

See Also:

Constant Field Values

DEFAULT_LIST_OF_ENTITIES_ALIAS

protected static final java.lang.String DEFAULT_LIST_OF_ENTITIES_ALIAS

See Also:

Constant Field Values

metadata

@Autowired
protected io.jmix.core.Metadata metadata

reportsPersistence

@Autowired
protected ReportsPersistence reportsPersistence

reportsUtils

@Autowired
protected ReportsUtils reportsUtils

reportsSerialization

@Autowired
protected ReportsSerialization reportsSerialization

reportsProperties

@Autowired
protected ReportsProperties reportsProperties

extendedEntities

@Autowired
protected io.jmix.core.ExtendedEntities extendedEntities

dataSetFactory

@Autowired
protected DataSetFactory dataSetFactory

messages

@Autowired
protected io.jmix.core.Messages messages

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

templateGenerator

@Autowired
protected TemplateGenerator templateGenerator

entityTreeModelBuilderApiProvider

@Autowired
protected javax.inject.Provider<EntityTreeModelBuilder> entityTreeModelBuilderApiProvider

fetchPlans

@Autowired
protected io.jmix.core.FetchPlans fetchPlans

Constructor Detail

ReportsWizard

public ReportsWizard()

Method Detail

toReport

public Report toReport(ReportData reportData,
                       boolean temporary)

createBands

protected java.util.Set<BandDefinition> createBands(Report report,
                                                    BandDefinition rootReportBandDefinition,
                                                    ReportData reportData,
                                                    ReportInputParameter mainParameter)

createParameters

@Nullable
protected ReportInputParameter createParameters(ReportData reportData,
                                                          Report report)

createReport

protected Report createReport(ReportData reportData,
                              boolean isTmp)

createJpqlDataSet

protected void createJpqlDataSet(ReportData reportData,
                                 ReportRegion reportRegion,
                                 BandDefinition dataBand)

createEntityDataSet

protected void createEntityDataSet(ReportData reportData,
                                   ReportRegion reportRegion,
                                   BandDefinition dataBand,
                                   ReportInputParameter mainParameter,
                                   io.jmix.core.FetchPlan parameterFetchPlan)

createRootBand

protected BandDefinition createRootBand(Report report)

createMainInputParameter

protected ReportInputParameter createMainInputParameter(Report report,
                                                        ReportData reportData)

createParameter

protected ReportInputParameter createParameter(Report report,
                                               int position)

createDefaultTemplate

protected ReportTemplate createDefaultTemplate(Report report,
                                               ReportData reportData)

createDataBand

protected BandDefinition createDataBand(Report report,
                                        BandDefinition rootBandDefinition,
                                        java.lang.String name,
                                        int bandDefPos)

createDefaultFormats

protected void createDefaultFormats(Report report,
                                    ReportData reportData,
                                    ReportRegion reportRegion)

createHeaderBand

protected BandDefinition createHeaderBand(Report report,
                                          BandDefinition rootReportBandDefinition,
                                          int bandDefPos,
                                          ReportRegion reportRegion)

createFetchPlanByReportRegions

public io.jmix.core.FetchPlan createFetchPlanByReportRegions(EntityTreeNode entityTreeRootNode,
                                                             java.util.List<ReportRegion> reportRegions)

createReportRegionByFetchPlan

public ReportRegion createReportRegionByFetchPlan(EntityTree entityTree,
                                                  boolean isTabulated,
                                                  @Nullable
                                                  io.jmix.core.FetchPlan fetchPlan,
                                                  @Nullable
                                                  java.lang.String collectionPropertyName)

Create report region using fetch plan and whole entity model as entityTree param For creating tabulated report region for collection of entity (when used # in alias of dataset) fetch plan and parameters must to be non-nul values because otherwise necessary ReportRegion.regionPropertiesRootNode field value will be null. That value is determined by that fetch plan.

Parameters:

entityTree - the whole entity tree model

isTabulated - determine which region will be created

fetchPlan - by that fetch plan the region will be created

collectionPropertyName - must to be non-null for a tabulated region

Returns:

report region

ensureParentFetchPlansExist

@Nullable
protected io.jmix.core.FetchPlanBuilder ensureParentFetchPlansExist(EntityTreeNode entityTreeNode,
                                                                              java.util.Map<EntityTreeNode,io.jmix.core.FetchPlanBuilder> fetchPlansForNodes)

Search for fetch plan for parent node If does not exists - createDataSet it and add property to parent of parent fetch plan

Parameters:

entityTreeNode - entity tree node

fetchPlansForNodes - fetch plans for previous nodes

Returns:

fetch plan builder

iterateFetchPlanAndCreatePropertiesForRegion

protected void iterateFetchPlanAndCreatePropertiesForRegion(boolean scalarOnly,
                                                            io.jmix.core.FetchPlan parentFetchPlan,
                                                            java.util.Map<java.lang.String,EntityTreeNode> allNodesAndHierarchicalPathsMap,
                                                            java.util.List<RegionProperty> regionProperties,
                                                            @Nullable
                                                            java.lang.String pathFromParentFetchPlan,
                                                            long propertyOrderNum)

nodesToMap

protected void nodesToMap(EntityTreeNode node,
                          java.util.Map<java.lang.String,EntityTreeNode> allNodesAndHierarchicalPathsMap)

isEntityAllowedForReportWizard

public boolean isEntityAllowedForReportWizard(io.jmix.core.metamodel.model.MetaClass effectiveMetaClass)

isPropertyAllowedForReportWizard

public boolean isPropertyAllowedForReportWizard(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                io.jmix.core.metamodel.model.MetaProperty metaProperty)

generateTemplate

public byte[] generateTemplate(ReportData reportData,
                               TemplateFileType templateFileType)
                        throws TemplateGenerationException

Throws:

TemplateGenerationException

buildEntityTree

public EntityTree buildEntityTree(io.jmix.core.metamodel.model.MetaClass metaClass)

getWizardBlackListedEntities

protected java.util.List<java.lang.String> getWizardBlackListedEntities()

getWizardWhiteListedEntities

protected java.util.List<java.lang.String> getWizardWhiteListedEntities()

getEffectiveEntities

protected java.util.List<java.lang.String> getEffectiveEntities(java.util.List<java.lang.String> entitiesList)

getWizardBlackListedProperties

protected java.util.List<java.lang.String> getWizardBlackListedProperties()

getWizardPropertiesExcludedBlackList

protected java.util.List<java.lang.String> getWizardPropertiesExcludedBlackList()

getOriginalMetaClass

protected io.jmix.core.metamodel.model.MetaClass getOriginalMetaClass(io.jmix.core.metamodel.model.MetaClass metaClass)