io.jmix.reports

Interface Reports

All Known Implementing Classes:

ReportsImpl

public interface Reports

API for reporting

Field Summary

Fields

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

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)
io.jmix.core.FileRef	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.
io.jmix.core.FileRef	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.
io.jmix.core.FileRef	createAndSaveReport(ReportRunParams reportRunParams) Generates a report and saves its output to the file storage.
io.jmix.core.FileRef	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.
io.jmix.core.metamodel.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> T	reloadEntity(T entity, io.jmix.core.FetchPlan fetchPlan)
Report	storeReportEntity(Report report) Saves Report entity to the database.

Field Detail

DEFAULT_TEMPLATE_CODE

static final java.lang.String DEFAULT_TEMPLATE_CODE

See Also:

Constant Field Values

Method Detail

storeReportEntity

Report storeReportEntity(Report report)

Saves Report entity to the database.

Parameters:

report - report entity instance

Returns:

saved instance

createReport

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

Generates a report.

Parameters:

report - entity instance defining the report

params - report parameters

Returns:

report output

createReport

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

Generates a report.

Parameters:

report - entity instance defining the report

params - report parameters

outputType - desired report output type

Returns:

report output

createReport

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.

Parameters:

report - entity instance defining the report

templateCode - code of a template to use

params - report parameters

Returns:

report output

createReport

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.

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

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

Generates a report.

Parameters:

report - entity instance defining the report

template - template to use

params - report parameters

Returns:

report output

createReport

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

Generates a report.

Parameters:

reportRunParams - all report parameters in a single POJO

Returns:

report output

createAndSaveReport

io.jmix.core.FileRef 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.

Parameters:

report - entity instance defining the report

params - report parameters

fileName - output file name

Returns:

FileDescriptor instance pointing to the report output

createAndSaveReport

io.jmix.core.FileRef 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.

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

io.jmix.core.FileRef 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.

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

io.jmix.core.FileRef createAndSaveReport(ReportRunParams reportRunParams)

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

Parameters:

reportRunParams - all report parameters in a single POJO

Returns:

FileDescriptor instance pointing to the report output

exportReports

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

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

Parameters:

reports - Collection of Report objects to be exported.

Returns:

ZIP byte array with zip archives inside.

importReports

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

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

Parameters:

zipBytes - ZIP archive as a byte array.

Returns:

Collection of imported reports.

importReports

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

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

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - - report import options

Returns:

Collection of imported reports.

importReportsWithResult

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

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

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - report - import options

Returns:

import result - collection of updated, created reports

convertToString

java.lang.String convertToString(Report report)

convertToReport

Report convertToReport(java.lang.String xml)

copyReport

Report copyReport(Report source)

bulkPrint

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. Put the result files to zip archive.

bulkPrint

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. Put the result files to zip archive.

reloadEntity

<T> T reloadEntity(T entity,
                   io.jmix.core.FetchPlan fetchPlan)

findMetaClassByDataSetEntityAlias

io.jmix.core.metamodel.model.MetaClass findMetaClassByDataSetEntityAlias(java.lang.String alias,
                                                                         DataSetType dataSetType,
                                                                         java.util.List<ReportInputParameter> reportInputParameters)

generateReportName

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

loadDataForParameterPrototype

java.util.List loadDataForParameterPrototype(ParameterPrototype prototype)

cancelReportExecution

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

Cancel report execution

Parameters:

userSessionId - - user session that started report execution

reportId - - identifier of executed report

currentDateOrTime

java.util.Date currentDateOrTime(ParameterType parameterType)

Get current date Date according to ParameterType value

Parameters:

parameterType - - ParameterType value.

Returns:

adjusted Date

convertToString

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

convertFromString

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