ro.nextreports.engine
Class ReportRunner

java.lang.Object
  ro.nextreports.engine.ReportRunner

All Implemented Interfaces:

Runner

public class ReportRunner
extends java.lang.Object
implements Runner

Utilities class to run a report

Field Summary

static java.lang.String	ALARM_FORMAT Memory alarm output format
static java.lang.String	CSV_FORMAT CSV output format
static java.lang.String	EXCEL_FORMAT EXCEL output format
static java.lang.String[]	FORMATS Array of all output persistent formats
static java.lang.String	HTML_FORMAT HTML output format
static java.lang.String	INDICATOR_FORMAT Memory indicator output format
static java.lang.String	PDF_FORMAT PDF output format
static java.lang.String	RTF_FORMAT RTF output format
static java.lang.String	TABLE_FORMAT Memory table output format
static java.lang.String	TSV_FORMAT TSV output format
static java.lang.String	TXT_FORMAT TXT output format
static java.lang.String	XML_FORMAT XML output format

Constructor Summary

ReportRunner()

Method Summary

void	addExporterEventListener(ro.nextreports.engine.exporter.event.ExporterEventListener listener) Add an exporter event listener
ro.nextreports.engine.exporter.util.AlarmData	getAlarmData() Get alarm data ALARM exporter
java.lang.String	getChartImagePath()
java.sql.Connection	getConnection() Get database connection
java.lang.String	getFormat() Get output format
ro.nextreports.engine.exporter.util.IndicatorData	getIndicatorData() Get indicator data INDICATOR exporter
java.util.Map<java.lang.String,java.lang.Object>	getParameterValues() Get parameters values
int	getQueryTimeout() Get query execution timeout
Report	getReport() Get next report object
ro.nextreports.engine.exporter.util.TableData	getTableData() Get table data TABLE exporter
boolean	isCancelled() See if export process was cancelled
boolean	isCount() See if we want to compute count
void	removeExporterEventListener(ro.nextreports.engine.exporter.event.ExporterEventListener listener) Remove an exporter event listener
boolean	run() Export the current report to the TABLE memory format
boolean	run(java.io.OutputStream stream) Export the current report to the specified output format
void	setAlerts(java.util.List<ro.nextreports.engine.exporter.Alert> alerts) Set a list of alert object for report of type alarm
void	setChartImagePath(java.lang.String chartImagePath)
void	setConnection(java.sql.Connection connection) Set database connection
void	setConnection(java.sql.Connection connection, boolean csv) Set database connection
void	setCount(boolean count) Set compute count
void	setFormat(java.lang.String format) Set output format
void	setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues) Set parameters values parameterValues is a map of parameters values where the key is the parameter name and the value is the parameter value(s) Such parameter value can be a simple java object if the parameter has SINGLE SELECTION, or in case of MULTIPLE SELECTION value is an array Object[] of java objects.
void	setQueryTimeout(int queryTimeout) Set query execution timeout
void	setReport(Report report) Set next report object
void	stop() Stop the export process

Methods inherited from class java.lang.Object

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

Field Detail

PDF_FORMAT

public static final java.lang.String PDF_FORMAT

PDF output format

See Also:

Constant Field Values

EXCEL_FORMAT

public static final java.lang.String EXCEL_FORMAT

EXCEL output format

See Also:

Constant Field Values

HTML_FORMAT

public static final java.lang.String HTML_FORMAT

HTML output format

See Also:

Constant Field Values

RTF_FORMAT

public static final java.lang.String RTF_FORMAT

RTF output format

See Also:

Constant Field Values

CSV_FORMAT

public static final java.lang.String CSV_FORMAT

CSV output format

See Also:

Constant Field Values

TSV_FORMAT

public static final java.lang.String TSV_FORMAT

TSV output format

See Also:

Constant Field Values

TXT_FORMAT

public static final java.lang.String TXT_FORMAT

TXT output format

See Also:

Constant Field Values

XML_FORMAT

public static final java.lang.String XML_FORMAT

XML output format

See Also:

Constant Field Values

FORMATS

public static final java.lang.String[] FORMATS

Array of all output persistent formats

TABLE_FORMAT

public static final java.lang.String TABLE_FORMAT

Memory table output format

See Also:

Constant Field Values

ALARM_FORMAT

public static final java.lang.String ALARM_FORMAT

Memory alarm output format

See Also:

Constant Field Values

INDICATOR_FORMAT

public static final java.lang.String INDICATOR_FORMAT

Memory indicator output format

See Also:

Constant Field Values

Constructor Detail

ReportRunner

public ReportRunner()

Method Detail

getConnection

public java.sql.Connection getConnection()

Get database connection

Returns:

database connection

setConnection

public void setConnection(java.sql.Connection connection)

Set database connection

Parameters:

connection - database connection

setConnection

public void setConnection(java.sql.Connection connection,
                          boolean csv)

Set database connection

Parameters:

connection - database connection

csv - true for a csv file connection

getReport

public Report getReport()

Get next report object

Returns:

next report object

setReport

public void setReport(Report report)

Set next report object

Parameters:

report - next report object

getParameterValues

public java.util.Map<java.lang.String,java.lang.Object> getParameterValues()

Get parameters values

Returns:

parameters values

setParameterValues

public void setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)

Set parameters values parameterValues is a map of parameters values where the key is the parameter name and the value is the parameter value(s) Such parameter value can be a simple java object if the parameter has SINGLE SELECTION, or in case of MULTIPLE SELECTION value is an array Object[] of java objects. For an empty list of values , the value must be : new Object[]{ParameterUtil.NULL} If we programatically add value(s) in parameterValues for a hidden parameter, the default values for that hidden parameter will be ignored and the engine will use those from the map.

Parameters:

parameterValues - parameters values

getFormat

public java.lang.String getFormat()

Get output format

Returns:

output format

setFormat

public void setFormat(java.lang.String format)

Set output format

Parameters:

format - output format

getQueryTimeout

public int getQueryTimeout()

Get query execution timeout

Returns:

query execution timeout in seconds

setQueryTimeout

public void setQueryTimeout(int queryTimeout)

Set query execution timeout

Parameters:

queryTimeout - query execution timeout in seconds

isCount

public boolean isCount()

See if we want to compute count

Returns:

true if count will be computed, false otrherwise

setCount

public void setCount(boolean count)

Set compute count

Parameters:

count - true for computing count

setAlerts

public void setAlerts(java.util.List<ro.nextreports.engine.exporter.Alert> alerts)

Set a list of alert object for report of type alarm

Parameters:

alerts - list of alert object

run

public boolean run()
            throws ReportRunnerException,
                   ro.nextreports.engine.exporter.exception.NoDataFoundException

Export the current report to the TABLE memory format

Specified by:

run in interface Runner

Returns:

true if export process finished, or false if export process was stopped

Throws:

ReportRunnerException - if FluentReportRunner object is not correctly configured

ro.nextreports.engine.exporter.exception.NoDataFoundException - if report has no data

run

public boolean run(java.io.OutputStream stream)
            throws ReportRunnerException,
                   ro.nextreports.engine.exporter.exception.NoDataFoundException

Export the current report to the specified output format

Specified by:

run in interface Runner

Parameters:

stream - output stream to write the exported report

Returns:

true if export process finished, or false if export process was stopped

Throws:

ReportRunnerException - if FluentReportRunner object is not correctly configured

ro.nextreports.engine.exporter.exception.NoDataFoundException - if report has no data

stop

public void stop()

Stop the export process

isCancelled

public boolean isCancelled()

See if export process was cancelled

Returns:

true if current process was cancelled, false otherwise

addExporterEventListener

public void addExporterEventListener(ro.nextreports.engine.exporter.event.ExporterEventListener listener)

Add an exporter event listener

Parameters:

listener - exporter event listener

removeExporterEventListener

public void removeExporterEventListener(ro.nextreports.engine.exporter.event.ExporterEventListener listener)

Remove an exporter event listener

Parameters:

listener - exporter event listener

getTableData

public ro.nextreports.engine.exporter.util.TableData getTableData()

Get table data TABLE exporter

Specified by:

getTableData in interface Runner

Returns:

table data for TABLE exporter

getAlarmData

public ro.nextreports.engine.exporter.util.AlarmData getAlarmData()

Get alarm data ALARM exporter

Specified by:

getAlarmData in interface Runner

Returns:

alarm data for ALARM exporter

getIndicatorData

public ro.nextreports.engine.exporter.util.IndicatorData getIndicatorData()

Get indicator data INDICATOR exporter

Specified by:

getIndicatorData in interface Runner

Returns:

indicator data for INDICATOR exporter

getChartImagePath

public java.lang.String getChartImagePath()

setChartImagePath

public void setChartImagePath(java.lang.String chartImagePath)