Class JsonExportStreamer

java.lang.Object

com.kingsrook.qqq.backend.core.actions.reporting.JsonExportStreamer

All Implemented Interfaces:

ExportStreamerInterface

public class JsonExportStreamer
extends Object
implements ExportStreamerInterface

JSON export format implementation

Constructor Summary

Constructors

Constructor	Description
JsonExportStreamer()

Method Summary

Modifier and Type	Method	Description
void	addRecords(List<QRecord> qRecords)	Called as records flow into the pipe.
void	addTotalsRow(QRecord record)
void	finish()	Called after all sheets are complete.
void	preRun(ReportDestination reportDestination, List<QReportView> views)	Called once, before any sheets are actually being produced.
void	start(ExportInput exportInput, List<QFieldMetaData> fields, String label, QReportView view)	Called once per sheet, before any rows are available.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.reporting.ExportStreamerInterface

setDisplayFormats, setExportStyleCustomizer

Constructor Details

JsonExportStreamer

public JsonExportStreamer()

Method Details

preRun

public void preRun(ReportDestination reportDestination,
 List<QReportView> views)
            throws QReportingException

Description copied from interface: ExportStreamerInterface

Called once, before any sheets are actually being produced.

Specified by:

preRun in interface ExportStreamerInterface

Throws:

QReportingException

start

public void start(ExportInput exportInput,
 List<QFieldMetaData> fields,
 String label,
 QReportView view)
           throws QReportingException

Description copied from interface: ExportStreamerInterface

Called once per sheet, before any rows are available. Meant to write a header, for example. If multiple sheets are being created, there is no separate end-sheet call. Rather, a new one will just get started...

Specified by:

start in interface ExportStreamerInterface

Throws:

QReportingException

addRecords

public void addRecords(List<QRecord> qRecords)
                throws QReportingException

Description copied from interface: ExportStreamerInterface

Called as records flow into the pipe.

Specified by:

addRecords in interface ExportStreamerInterface

Throws:

QReportingException

addTotalsRow

public void addTotalsRow(QRecord record)
                  throws QReportingException

Specified by:

addTotalsRow in interface ExportStreamerInterface

Throws:

QReportingException

finish

public void finish()
            throws QReportingException

Description copied from interface: ExportStreamerInterface

Called after all sheets are complete. Meant to do a final write, or close resources, for example.

Specified by:

finish in interface ExportStreamerInterface

Throws:

QReportingException