Module com.aoapps.dao.dbc

Package com.aoapps.dao.dbc

Class QueryReport

java.lang.Object

com.aoapps.dao.dbc.QueryReport

All Implemented Interfaces:

Report

public abstract class QueryReport
extends Object
implements Report

A report that is obtained from a SQL query database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryReport.QueryColumn	A column obtained from a database query.
static class	QueryReport.ReportResult	A result obtained from a database query.

Nested classes/interfaces inherited from interface com.aoapps.dao.Report

Report.Alignment, Report.Column, Report.Parameter, Report.Result

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryReport(Database database, String name, String sql, Object... params)	Construct a new query report.
protected	QueryReport(Database database, String name, String sql, Collection<?> params)	Construct a new query report.

Method Summary

Modifier and Type	Method	Description
void	afterQuery(Map<String,? extends Object> parameterValues, Connection conn)	Called in try/finally after the query is executed, this may release any temp tables or views that were setup by beforeQuery(java.util.Map, java.sql.Connection).
void	beforeQuery(Map<String,? extends Object> parameterValues, Connection conn)	Called before the query is executed, this may setup any temp tables or views that are required by the main query.
QueryReport.ReportResult	executeReport(Map<String,? extends Object> parameterValues)
String	getColumnLabel(QueryReport.QueryColumn column)	Gets the label for the provided column.
String	getDescription(Map<String,? extends Object> parameterValues)	Defaults to calling getDescription().
String	getName()
Iterable<? extends Report.Parameter>	getParameters()	Get default, no parameters are required.
String	getTitle(Map<String,? extends Object> parameterValues)	Defaults to calling getTitle().
boolean	isReadOnly()	Checks if this is a read-only report.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.dao.Report

getDescription, getTitle

Constructor Details

QueryReport

protected QueryReport(Database database,
 String name,
 String sql,
 Object... params)

Construct a new query report.

Parameters:

params - to substitute a parameter, provide the Parameter object.

QueryReport

protected QueryReport(Database database,
 String name,
 String sql,
 Collection<?> params)

Construct a new query report.

Parameters:

params - to substitute a parameter, provide the Parameter object.

Method Details

getName

public String getName()

Specified by:

getName in interface Report

getTitle

public String getTitle(Map<String,? extends Object> parameterValues)

Defaults to calling getTitle().

Specified by:

getTitle in interface Report

getDescription

public String getDescription(Map<String,? extends Object> parameterValues)

Defaults to calling getDescription().

Specified by:

getDescription in interface Report

getColumnLabel

public String getColumnLabel(QueryReport.QueryColumn column)

Gets the label for the provided column. Defaults to column name.

See Also:

• QueryReport.QueryColumn.getLabel()

getParameters

public Iterable<? extends Report.Parameter> getParameters()

Get default, no parameters are required.

Specified by:

getParameters in interface Report

isReadOnly

public boolean isReadOnly()

Checks if this is a read-only report. No temp tables or views may be created on a read-only report. Defaults to true.

executeReport

public QueryReport.ReportResult executeReport(Map<String,? extends Object> parameterValues)
                                       throws SQLException

Specified by:

executeReport in interface Report

Throws:

SQLException

beforeQuery

public void beforeQuery(Map<String,? extends Object> parameterValues,
 Connection conn)
                 throws SQLException

Called before the query is executed, this may setup any temp tables or views that are required by the main query.

This default implementation does nothing.

Throws:

SQLException

See Also:

• afterQuery(java.util.Map, java.sql.Connection)

afterQuery

public void afterQuery(Map<String,? extends Object> parameterValues,
 Connection conn)
                throws SQLException

Called in try/finally after the query is executed, this may release any temp tables or views that were setup by beforeQuery(java.util.Map, java.sql.Connection). This will be called even when the beforeQuery does not complete fully, and the conn may already be closed or otherwise in an invalid state.

This default implementation does nothing.

Throws:

SQLException

See Also:

• beforeQuery(java.util.Map, java.sql.Connection)