com.haulmont.reports

Class ReportingBean

java.lang.Object

com.haulmont.reports.ReportingBean

All Implemented Interfaces:

ReportingApi

@Component(value="report_ReportingApi")
public class ReportingBean
extends java.lang.Object
implements ReportingApi

Field Summary

Fields

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

Fields inherited from interface com.haulmont.reports.ReportingApi

NAME

Constructor Summary

Constructors

Constructor and Description
ReportingBean()

Method Summary

Modifier and Type	Method and Description
com.haulmont.yarg.reporting.ReportOutputDocument	bulkPrint(Report report, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList) Prints the report several times for each parameter map in the paramsList.
com.haulmont.yarg.reporting.ReportOutputDocument	bulkPrint(Report report, java.lang.String templateCode, ReportOutputType outputType, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList) Prints the report several times for each parameter map in the paramsList.
void	cancelReportExecution(java.util.UUID userSessionId, java.util.UUID reportId) Cancel report execution
Report	convertToReport(java.lang.String serializedReport)
java.lang.String	convertToString(Report report)
Report	copyReport(Report source)
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName) Generates a report and saves its output to the file storage.
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, ReportTemplate template, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName) Generates a report and saves its output to the file storage.
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(ReportRunParams reportRunParams) Generates a report and saves its output to the file storage.
com.haulmont.cuba.core.entity.FileDescriptor	createAndSaveReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String fileName) Generates a report and saves its output to the file storage.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params) Generates a report.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType) Generates a report.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, ReportTemplate template, java.util.Map<java.lang.String,java.lang.Object> params) Generates a report.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(ReportRunParams reportRunParams) Generates a report.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params) Generates a report.
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType) Generates a report.
java.util.Date	currentDateOrTime(ParameterType parameterType) Get current date Date according to ParameterType value
byte[]	exportReports(java.util.Collection<Report> reports) Exports all reports and their templates into one zip archive.
com.haulmont.chile.core.model.MetaClass	findMetaClassByDataSetEntityAlias(java.lang.String alias, DataSetType dataSetType, java.util.List<ReportInputParameter> reportInputParameters)
java.lang.String	generateReportName(java.lang.String sourceName)
java.util.Collection<Report>	importReports(byte[] zipBytes) Imports reports from ZIP archive.
java.util.Collection<Report>	importReports(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions) Imports reports from ZIP archive.
ReportImportResult	importReportsWithResult(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions) Imports reports from ZIP archive.
java.util.List	loadDataForParameterPrototype(ParameterPrototype prototype)
<T extends com.haulmont.cuba.core.entity.Entity> T	reloadEntity(T entity, com.haulmont.cuba.core.global.View view)
Report	storeReportEntity(Report report) Saves Report entity to the database.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_EDIT_VIEW_NAME

public static final java.lang.String REPORT_EDIT_VIEW_NAME

See Also:

Constant Field Values

Constructor Detail

ReportingBean

public ReportingBean()

Method Detail

storeReportEntity

public Report storeReportEntity(Report report)

Description copied from interface: ReportingApi

Saves Report entity to the database.

Specified by:

storeReportEntity in interface ReportingApi

Parameters:

report - report entity instance

Returns:

saved instance

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

report - entity instance defining the report

params - report parameters

Returns:

report output

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params,
                                                                     ReportOutputType outputType)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

report - entity instance defining the report

params - report parameters

outputType - desired report output type

Returns:

report output

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                                     java.lang.String templateCode,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

report - entity instance defining the report

templateCode - code of a template to use

params - report parameters

Returns:

report output

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                                     java.lang.String templateCode,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params,
                                                                     ReportOutputType outputType)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

report - entity instance defining the report

templateCode - code of a template to use

params - report parameters

outputType - desired report output type

Returns:

report output

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(ReportRunParams reportRunParams)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

reportRunParams - all report parameters in a single POJO

Returns:

report output

bulkPrint

public com.haulmont.yarg.reporting.ReportOutputDocument bulkPrint(Report report,
                                                                  java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)

Description copied from interface: ReportingApi

Prints the report several times for each parameter map in the paramsList. Put the result files to zip archive.

Specified by:

bulkPrint in interface ReportingApi

bulkPrint

public com.haulmont.yarg.reporting.ReportOutputDocument bulkPrint(Report report,
                                                                  java.lang.String templateCode,
                                                                  ReportOutputType outputType,
                                                                  java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paramsList)

Description copied from interface: ReportingApi

Prints the report several times for each parameter map in the paramsList. Put the result files to zip archive.

Specified by:

bulkPrint in interface ReportingApi

createReport

public com.haulmont.yarg.reporting.ReportOutputDocument createReport(Report report,
                                                                     ReportTemplate template,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: ReportingApi

Generates a report.

Specified by:

createReport in interface ReportingApi

Parameters:

report - entity instance defining the report

template - template to use

params - report parameters

Returns:

report output

loadDataForParameterPrototype

public java.util.List loadDataForParameterPrototype(ParameterPrototype prototype)

Specified by:

loadDataForParameterPrototype in interface ReportingApi

copyReport

public Report copyReport(Report source)

Specified by:

copyReport in interface ReportingApi

exportReports

public byte[] exportReports(java.util.Collection<Report> reports)

Description copied from interface: ReportingApi

Exports all reports and their templates into one zip archive. Each report is exported into a separate zip archive with 2 files (report.xml and a template file (for example MyReport.doc)). For example: return byte[] (bytes of zip arhive) -- MegaReport.zip ---- report.xml ---- Mega report.xls -- Other report.zip ---- report.xml ---- other report.odt

Specified by:

exportReports in interface ReportingApi

Parameters:

reports - Collection of Report objects to be exported.

Returns:

ZIP byte array with zip archives inside.

createAndSaveReport

public com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        java.lang.String fileName)

Description copied from interface: ReportingApi

Generates a report and saves its output to the file storage.

Specified by:

createAndSaveReport in interface ReportingApi

Parameters:

report - entity instance defining the report

params - report parameters

fileName - output file name

Returns:

FileDescriptor instance pointing to the report output

createAndSaveReport

public com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                        java.lang.String templateCode,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        java.lang.String fileName)

Description copied from interface: ReportingApi

Generates a report and saves its output to the file storage.

Specified by:

createAndSaveReport in interface ReportingApi

Parameters:

report - entity instance defining the report

templateCode - code of a template to use

params - report parameters

fileName - output file name

Returns:

FileDescriptor instance pointing to the report output

createAndSaveReport

public com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(Report report,
                                                                        ReportTemplate template,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        java.lang.String fileName)

Description copied from interface: ReportingApi

Generates a report and saves its output to the file storage.

Specified by:

createAndSaveReport in interface ReportingApi

Parameters:

report - entity instance defining the report

template - template to use

params - report parameters

fileName - output file name

Returns:

FileDescriptor instance pointing to the report output

createAndSaveReport

public com.haulmont.cuba.core.entity.FileDescriptor createAndSaveReport(ReportRunParams reportRunParams)

Description copied from interface: ReportingApi

Generates a report and saves its output to the file storage.

Specified by:

createAndSaveReport in interface ReportingApi

Parameters:

reportRunParams - all report parameters in a single POJO

Returns:

FileDescriptor instance pointing to the report output

importReports

public java.util.Collection<Report> importReports(byte[] zipBytes)

Description copied from interface: ReportingApi

Imports reports from ZIP archive. Archive file format is described in exportReports method.

Specified by:

importReports in interface ReportingApi

Parameters:

zipBytes - ZIP archive as a byte array.

Returns:

Collection of imported reports.

importReports

public java.util.Collection<Report> importReports(byte[] zipBytes,
                                                  java.util.EnumSet<ReportImportOption> importOptions)

Description copied from interface: ReportingApi

Imports reports from ZIP archive. Archive file format is described in exportReports method.

Specified by:

importReports in interface ReportingApi

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - - report import options

Returns:

Collection of imported reports.

importReportsWithResult

public ReportImportResult importReportsWithResult(byte[] zipBytes,
                                                  java.util.EnumSet<ReportImportOption> importOptions)

Description copied from interface: ReportingApi

Imports reports from ZIP archive. Archive file format is described in exportReports method.

Specified by:

importReportsWithResult in interface ReportingApi

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - report - import options

Returns:

import result - collection of updated, created reports

convertToString

public java.lang.String convertToString(Report report)

Specified by:

convertToString in interface ReportingApi

convertToReport

public Report convertToReport(java.lang.String serializedReport)

Specified by:

convertToReport in interface ReportingApi

reloadEntity

public <T extends com.haulmont.cuba.core.entity.Entity> T reloadEntity(T entity,
                                                                       com.haulmont.cuba.core.global.View view)

Specified by:

reloadEntity in interface ReportingApi

findMetaClassByDataSetEntityAlias

public com.haulmont.chile.core.model.MetaClass findMetaClassByDataSetEntityAlias(java.lang.String alias,
                                                                                 DataSetType dataSetType,
                                                                                 java.util.List<ReportInputParameter> reportInputParameters)

Specified by:

findMetaClassByDataSetEntityAlias in interface ReportingApi

generateReportName

public java.lang.String generateReportName(java.lang.String sourceName)

Specified by:

generateReportName in interface ReportingApi

cancelReportExecution

public void cancelReportExecution(java.util.UUID userSessionId,
                                  java.util.UUID reportId)

Description copied from interface: ReportingApi

Cancel report execution

Specified by:

cancelReportExecution in interface ReportingApi

Parameters:

userSessionId - - user session that started report execution

reportId - - identifier of executed report

currentDateOrTime

public java.util.Date currentDateOrTime(ParameterType parameterType)

Description copied from interface: ReportingApi

Get current date Date according to ParameterType value

Specified by:

currentDateOrTime in interface ReportingApi

Parameters:

parameterType - - ParameterType value.

Returns:

adjusted Date