Class ExportAction

java.lang.Object

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

public class ExportAction
extends Object

Action to generate an export from a table At this time (future may change?), this action starts a new thread to run the query in the backend module. As records are produced by the query, they are put into a RecordPipe, which the ReportStreamer pulls from, to write to the report output stream. This action will block until the query job is complete, and the final records have been consumed from the pipe, at which time the report outputStream can be closed.

Constructor Summary

Constructors

Constructor	Description
ExportAction()

Method Summary

Modifier and Type	Method	Description
ExportOutput	execute(ExportInput exportInput)	Run the report.
void	preExecute(ExportInput exportInput)	Validation logic, that will run before the action is executed -- ideally, if a caller is going to run the execution in a thread, they'd call this method first, in their thread, to catch any validation errors before they start the thread (which they may abandon).

Methods inherited from class java.lang.Object

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

Constructor Details

ExportAction

public ExportAction()

Method Details

preExecute

public void preExecute(ExportInput exportInput)
                throws QException

Validation logic, that will run before the action is executed -- ideally, if a caller is going to run the execution in a thread, they'd call this method first, in their thread, to catch any validation errors before they start the thread (which they may abandon).

Throws:

QException

execute

public ExportOutput execute(ExportInput exportInput)
                     throws QException

Run the report.

Throws:

QException