io.jmix.reports.impl

Class ReportImportExportImpl

java.lang.Object

io.jmix.reports.impl.ReportImportExportImpl

All Implemented Interfaces:

ReportImportExport

@Component(value="report_ReportImportExport")
public class ReportImportExportImpl
extends java.lang.Object
implements ReportImportExport

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.DataManager	dataManager
static java.lang.String	ENCODING
protected io.jmix.core.Metadata	metadata
protected ReportsPersistence	reportsPersistence
protected ReportsSerialization	reportsSerialization

Constructor Summary

Constructors

Constructor and Description
ReportImportExportImpl()

Method Summary

Modifier and Type	Method and Description
protected byte[]	exportReport(Report report) Exports single report to ZIP archive with name <report name>.zip.
byte[]	exportReports(java.util.Collection<Report> reports) Exports all reports and their templates into one zip archive.
protected Report	fromByteArray(byte[] zipBytes)
protected void	importReport(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions, ReportImportResult importResult)
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.
java.util.Collection<Report>	importReportsFromPath(java.lang.String path) Import all reports from the specified folder.
ReportImportResult	importReportsWithResult(byte[] zipBytes, java.util.EnumSet<ReportImportOption> importOptions) Imports reports from ZIP archive.
protected boolean	isReportsStructureFile(java.lang.String name)
protected org.apache.commons.compress.archivers.ArchiveEntry	newStoredEntry(java.lang.String name, byte[] data)
protected byte[]	readBytesFromEntry(org.apache.commons.compress.archivers.zip.ZipArchiveInputStream archiveReader)
protected Report	reloadReport(Report report)
protected java.lang.String	replaceForbiddenCharacters(java.lang.String fileName)
protected void	updateReportTemplate(Report report, byte[] zipBytes)
protected void	withReportOptions(Report report, java.util.EnumSet<ReportImportOption> importOptions)
protected byte[]	zipContent(java.util.Map<java.lang.String,java.lang.Object> stringObjectMap)
protected byte[]	zipSingleReportFiles(java.io.File[] files)

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final java.lang.String ENCODING

See Also:

Constant Field Values

reportsPersistence

@Autowired
protected ReportsPersistence reportsPersistence

reportsSerialization

@Autowired
protected ReportsSerialization reportsSerialization

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

metadata

@Autowired
protected io.jmix.core.Metadata metadata

Constructor Detail

ReportImportExportImpl

public ReportImportExportImpl()

Method Detail

exportReports

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

Description copied from interface: ReportImportExport

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 ReportImportExport

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

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

Specified by:

importReports in interface ReportImportExport

Parameters:

zipBytes - ZIP archive as a byte array.

Returns:

Collection of imported reports.

importReports

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

Description copied from interface: ReportImportExport

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

Specified by:

importReports in interface ReportImportExport

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - - report import options

Returns:

Collection of imported reports.

importReportsWithResult

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

Description copied from interface: ReportImportExport

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

Specified by:

importReportsWithResult in interface ReportImportExport

Parameters:

zipBytes - ZIP archive as a byte array.

importOptions - report - import options

Returns:

import result - collection of updated, created reports

importReportsFromPath

public java.util.Collection<Report> importReportsFromPath(java.lang.String path)
                                                   throws java.io.IOException

Description copied from interface: ReportImportExport

Import all reports from the specified folder. Folder should have the following structure, in other cases RuntimeException will be thrown

folder sub-folder1 report.structure template.doc sub-folder2 report.structure template.docx

Specified by:

importReportsFromPath in interface ReportImportExport

Parameters:

path - to folder with reports

Returns:

collection of imported reports

Throws:

java.io.IOException - if any I/O error occurs

exportReport

protected byte[] exportReport(Report report)
                       throws java.io.IOException

Exports single report to ZIP archive with name <report name>.zip. There are 2 files in archive: report.structure and a template file (odt, xls or other..)

Parameters:

report - Report object that must be exported.

Returns:

ZIP archive as a byte array.

Throws:

java.io.IOException - if any I/O error occurs

importReport

protected void importReport(byte[] zipBytes,
                            @Nullable
                            java.util.EnumSet<ReportImportOption> importOptions,
                            ReportImportResult importResult)
                     throws java.io.IOException

Throws:

java.io.IOException

fromByteArray

@Nullable
protected Report fromByteArray(byte[] zipBytes)
                                  throws java.io.IOException

Throws:

java.io.IOException

updateReportTemplate

protected void updateReportTemplate(Report report,
                                    byte[] zipBytes)
                             throws java.io.IOException

Throws:

java.io.IOException

withReportOptions

protected void withReportOptions(Report report,
                                 @Nullable
                                 java.util.EnumSet<ReportImportOption> importOptions)

zipSingleReportFiles

protected byte[] zipSingleReportFiles(java.io.File[] files)
                               throws java.io.IOException

Throws:

java.io.IOException

zipContent

protected byte[] zipContent(java.util.Map<java.lang.String,java.lang.Object> stringObjectMap)
                     throws java.io.IOException

Throws:

java.io.IOException

newStoredEntry

protected org.apache.commons.compress.archivers.ArchiveEntry newStoredEntry(java.lang.String name,
                                                                            byte[] data)

replaceForbiddenCharacters

protected java.lang.String replaceForbiddenCharacters(java.lang.String fileName)

readBytesFromEntry

protected byte[] readBytesFromEntry(org.apache.commons.compress.archivers.zip.ZipArchiveInputStream archiveReader)
                             throws java.io.IOException

Throws:

java.io.IOException

reloadReport

@Nullable
protected Report reloadReport(Report report)

isReportsStructureFile

protected boolean isReportsStructureFile(java.lang.String name)