Package biz.aQute.bnd.reporter.exporter
Class ReportExporter
- java.lang.Object
-
- biz.aQute.bnd.reporter.exporter.ReportExporter
-
- All Implemented Interfaces:
ReportExporterService
class ReportExporter extends java.lang.Object implements ReportExporterService
Provide the ReportExporterService service. This implementation is configured by the user with theReportExporterConstants.EXPORT_REPORT_INSTRUCTION
instruction.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
ReportExporter.Cache
(package private) static interface
ReportExporter.ReportExporterInstructions
-
Field Summary
Fields Modifier and Type Field Description private ReportExporter.Cache
_cache
private ReportGeneratorService
_generator
private Processor
_processor
private java.lang.String
_scope
-
Constructor Summary
Constructors Constructor Description ReportExporter(java.lang.String scope, Processor processor, ReportGeneratorService generator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,Resource>
exportReportsOf(java.lang.Object source)
Export the reports of the specified source object.java.util.List<java.lang.String>
getAvailableReportsOf(java.lang.Object source)
private java.lang.String[]
getAvailableSerializerExtensions()
private java.lang.String[]
getAvailableTransformerExtensions()
private java.util.Map<java.lang.String,java.lang.Object>
getGeneratedReport(java.lang.Object source, java.lang.String locale, java.lang.String configName)
private byte[]
getGeneratedReport(java.lang.Object source, java.lang.String locale, java.lang.String configName, java.lang.String extension)
private java.util.Map<java.lang.String,ReportExporter.ReportExporterInstructions.ExportReportInstruction>
getScopedExportInstruction()
private java.util.Map.Entry<java.lang.String,Resource>
getTemplateResource(ReportExporter.ReportExporterInstructions.ExportReportInstruction instruction, java.io.File destination, java.io.File base)
private byte[]
serializeReport(java.util.Map<java.lang.String,java.lang.Object> reportDTO, java.lang.String extension)
private byte[]
transform(java.lang.Object source, java.lang.String locale, java.lang.String configName, Resource templateResource, java.lang.String templateExtension, Attrs parameters)
-
-
-
Field Detail
-
_processor
private final Processor _processor
-
_scope
private final java.lang.String _scope
-
_generator
private final ReportGeneratorService _generator
-
_cache
private final ReportExporter.Cache _cache
-
-
Constructor Detail
-
ReportExporter
ReportExporter(java.lang.String scope, Processor processor, ReportGeneratorService generator)
-
-
Method Detail
-
getAvailableReportsOf
public java.util.List<java.lang.String> getAvailableReportsOf(java.lang.Object source)
- Specified by:
getAvailableReportsOf
in interfaceReportExporterService
- Parameters:
source
- the targeted source object to report, may benull
- Returns:
- the list of report destination file paths which can be extracted,
never
null
-
exportReportsOf
public java.util.Map<java.lang.String,Resource> exportReportsOf(java.lang.Object source)
Description copied from interface:ReportExporterService
Export the reports of the specified source object.- Specified by:
exportReportsOf
in interfaceReportExporterService
- Parameters:
source
- the source object to report, may benull
- Returns:
- a map whose key are the user defined destination file path and
value are the resulting report resource, never
null
-
getTemplateResource
private java.util.Map.Entry<java.lang.String,Resource> getTemplateResource(ReportExporter.ReportExporterInstructions.ExportReportInstruction instruction, java.io.File destination, java.io.File base)
-
transform
private byte[] transform(java.lang.Object source, java.lang.String locale, java.lang.String configName, Resource templateResource, java.lang.String templateExtension, Attrs parameters)
-
getGeneratedReport
private java.util.Map<java.lang.String,java.lang.Object> getGeneratedReport(java.lang.Object source, java.lang.String locale, java.lang.String configName)
-
getGeneratedReport
private byte[] getGeneratedReport(java.lang.Object source, java.lang.String locale, java.lang.String configName, java.lang.String extension)
-
serializeReport
private byte[] serializeReport(java.util.Map<java.lang.String,java.lang.Object> reportDTO, java.lang.String extension)
-
getAvailableSerializerExtensions
private java.lang.String[] getAvailableSerializerExtensions()
-
getAvailableTransformerExtensions
private java.lang.String[] getAvailableTransformerExtensions()
-
getScopedExportInstruction
private java.util.Map<java.lang.String,ReportExporter.ReportExporterInstructions.ExportReportInstruction> getScopedExportInstruction()
-
-