com.haulmont.reports

Class ReportServiceBean

java.lang.Object

com.haulmont.reports.ReportServiceBean

All Implemented Interfaces:

ReportService

@Service(value="report_ReportService")
public class ReportServiceBean
extends java.lang.Object
implements ReportService

Field Summary

Fields inherited from interface com.haulmont.reports.app.service.ReportService

DEFAULT_TEMPLATE_CODE, MAIN_VIEW_NAME, NAME

Constructor Summary

Constructors

Constructor and Description
ReportServiceBean()

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
java.lang.Object	convertFromString(java.lang.Class parameterClass, java.lang.String paramValueStr)
Report	convertToReport(java.lang.String xml)
java.lang.String	convertToString(java.lang.Class parameterClass, java.lang.Object paramValue)
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)
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)
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)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, ReportTemplate template, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params)
com.haulmont.yarg.reporting.ReportOutputDocument	createReport(Report report, java.lang.String templateCode, java.util.Map<java.lang.String,java.lang.Object> params, ReportOutputType outputType)
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.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)
Report	storeReportEntity(Report report)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportServiceBean

public ReportServiceBean()

Method Detail

storeReportEntity

public Report storeReportEntity(Report report)

Specified by:

storeReportEntity in interface ReportService

createReport

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

Specified by:

createReport in interface ReportService

createReport

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

Specified by:

createReport in interface ReportService

createReport

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

Specified by:

createReport in interface ReportService

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)

Specified by:

createReport in interface ReportService

createReport

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

Specified by:

createReport in interface ReportService

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)

Specified by:

createAndSaveReport in interface ReportService

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)

Specified by:

createAndSaveReport in interface ReportService

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)

Specified by:

createAndSaveReport in interface ReportService

exportReports

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

Description copied from interface: ReportService

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 ReportService

Parameters:

reports - Collection of Report objects to be exported.

Returns:

ZIP byte array with zip archives inside.

importReports

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

Description copied from interface: ReportService

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

Specified by:

importReports in interface ReportService

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: ReportService

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

Specified by:

importReports in interface ReportService

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: ReportService

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

Specified by:

importReportsWithResult in interface ReportService

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 ReportService

convertToReport

public Report convertToReport(java.lang.String xml)

Specified by:

convertToReport in interface ReportService

copyReport

public Report copyReport(Report source)

Specified by:

copyReport in interface ReportService

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: ReportService

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

Specified by:

bulkPrint in interface ReportService

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: ReportService

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

Specified by:

bulkPrint in interface ReportService

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 ReportService

loadDataForParameterPrototype

public java.util.List loadDataForParameterPrototype(ParameterPrototype prototype)

Specified by:

loadDataForParameterPrototype in interface ReportService

convertToString

public java.lang.String convertToString(java.lang.Class parameterClass,
                                        java.lang.Object paramValue)

Specified by:

convertToString in interface ReportService

convertFromString

public java.lang.Object convertFromString(java.lang.Class parameterClass,
                                          java.lang.String paramValueStr)

Specified by:

convertFromString in interface ReportService

cancelReportExecution

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

Description copied from interface: ReportService

Cancel report execution

Specified by:

cancelReportExecution in interface ReportService

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: ReportService

Get current date Date according to ParameterType value

Specified by:

currentDateOrTime in interface ReportService

Parameters:

parameterType - - ParameterType value.

Returns:

adjusted Date