com.haulmont.reports.wizard

Class ReportingWizardBean

java.lang.Object

com.haulmont.reports.wizard.ReportingWizardBean

All Implemented Interfaces:

ReportingWizardApi

@Component(value="report_ReportingWizardApi")
public class ReportingWizardBean
extends java.lang.Object
implements ReportingWizardApi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT_BAND_DEFINITION_NAME

Fields inherited from interface com.haulmont.reports.wizard.ReportingWizardApi

NAME

Constructor Summary

Constructors

Constructor and Description
ReportingWizardBean()

Method Summary

Modifier and Type	Method and Description
ReportRegion	createReportRegionByView(EntityTree entityTree, boolean isTabulated, com.haulmont.cuba.core.global.View view, java.lang.String collectionPropertyName) Create report region using view and whole entity model as entityTree param For creating tabulated report region for collection of entity (when used # in alias of dataset) view and parameters must to be non-nul values because otherwise necessary ReportRegion.regionPropertiesRootNode field value will be null.
com.haulmont.cuba.core.global.View	createViewByReportRegions(EntityTreeNode entityTreeRootNode, java.util.List<ReportRegion> reportRegions)
boolean	isEntityAllowedForReportWizard(com.haulmont.chile.core.model.MetaClass effectiveMetaClass)
boolean	isPropertyAllowedForReportWizard(com.haulmont.chile.core.model.MetaClass metaClass, com.haulmont.chile.core.model.MetaProperty metaProperty)
Report	toReport(ReportData reportData, boolean temporary)

Methods inherited from class java.lang.Object

equals, 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

Constructor Detail

ReportingWizardBean

public ReportingWizardBean()

Method Detail

toReport

public Report toReport(ReportData reportData,
                       boolean temporary)

Specified by:

toReport in interface ReportingWizardApi

createViewByReportRegions

public com.haulmont.cuba.core.global.View createViewByReportRegions(EntityTreeNode entityTreeRootNode,
                                                                    java.util.List<ReportRegion> reportRegions)

Specified by:

createViewByReportRegions in interface ReportingWizardApi

createReportRegionByView

public ReportRegion createReportRegionByView(EntityTree entityTree,
                                             boolean isTabulated,
                                             @Nullable
                                             com.haulmont.cuba.core.global.View view,
                                             @Nullable
                                             java.lang.String collectionPropertyName)

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

Specified by:

createReportRegionByView in interface ReportingWizardApi

Parameters:

entityTree - the whole entity tree model

isTabulated - determine which region will be created

view - by that view region will be created

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

Returns:

report region

isEntityAllowedForReportWizard

public boolean isEntityAllowedForReportWizard(com.haulmont.chile.core.model.MetaClass effectiveMetaClass)

Specified by:

isEntityAllowedForReportWizard in interface ReportingWizardApi

isPropertyAllowedForReportWizard

public boolean isPropertyAllowedForReportWizard(com.haulmont.chile.core.model.MetaClass metaClass,
                                                com.haulmont.chile.core.model.MetaProperty metaProperty)

Specified by:

isPropertyAllowedForReportWizard in interface ReportingWizardApi