|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQReport
This interface provides a way to link multiple data sets together and presents them as a single report.
Data sets listed below are currently supported: And, as of this release, a report can be presented in one of the following ways:AQDataSetSettings
for an example about how
a data set is typically formatted.
Multiple reports can also be linked together, please see
AQReportSettings
for more information.
Method Summary | |
---|---|
void |
addDataSet(AQDataSet dataSet,
AQReportDataSetSettings settings)
Adds a data set to this report. |
void |
addDataSet(AQDataSet dataSet,
AQReportDataSetSettings settings,
AQChart chart)
Adds a data set, with chart enabled, to this report. |
void |
addDataSet(AQPivotDataSet dataSet,
AQReportDataSetSettings settings)
Adds a pivot data set to this report. |
void |
addDataSet(AQPivotDataSet dataSet,
AQReportDataSetSettings settings,
AQChart chart)
Adds a pivot data set, with chart enabled, to this report. |
byte[] |
getAsExcel2003()
Returns this report as a byte array representing an Excel 2003 file. |
byte[] |
getAsExcel2007()
Returns this report as a byte array representing an Excel 2007 file. |
AQReportSettings |
getSettings()
Returns the settings that define how this report to be rendered. |
String |
renderHtml()
Renders this report in HTML. |
String |
renderText()
Renders this report in plain text. |
void |
saveAsExcel2003(String fileName)
Saves this report as an Excel 2003 file. |
void |
saveAsExcel2007(String fileName)
Saves this report as an Excel 2007 file. |
void |
saveTo(AQExcelSpreadsheet spreadsheet)
Inserts report in an Excel spreadsheet. |
void |
setSettings(AQReportSettings settings)
Sets settings for this report. |
Method Detail |
---|
void setSettings(AQReportSettings settings)
settings
- the report settings, default settings is used if nullAQReportSettings getSettings()
setSettings(AQReportSettings settings)
can be used to set custom settings.
void addDataSet(AQDataSet dataSet, AQReportDataSetSettings settings)
dataSet
- the data setsettings
- the data set settings, default settings is used if nullvoid addDataSet(AQDataSet dataSet, AQReportDataSetSettings settings, AQChart chart)
chart
parameter cannot be null and is expected to be created from the
specified dataSet
with data source and chart properties properly defined.
dataSet
- the data setsettings
- the data set settings, default settings is used if nullchart
- the chart created from the specified dataSetvoid addDataSet(AQPivotDataSet dataSet, AQReportDataSetSettings settings)
dataSet
- the pivot data setsettings
- the data set settings, default settings is used if nullvoid addDataSet(AQPivotDataSet dataSet, AQReportDataSetSettings settings, AQChart chart)
chart
parameter cannot be null and is expected to be created from the
specified dataSet
with data source and chart properties properly defined.
dataSet
- the pivot data setsettings
- the data set settings, default settings is used if nullchart
- the chart created from the specified dataSetString renderText() throws Exception
Exception
- if none of contained data sets can be renderedString renderHtml() throws Exception
Exception
- if none of contained data sets can be renderedvoid saveAsExcel2003(String fileName) throws Exception
fileName
- the name of the file where report to be saved
Exception
- if none of contained data sets can be converted to Excelvoid saveAsExcel2007(String fileName) throws Exception
fileName
- the name of the file where report to be saved
Exception
- if none of contained data sets can be converted to Excelbyte[] getAsExcel2003() throws Exception
Exception
- if none of contained data sets can be converted to Excelbyte[] getAsExcel2007() throws Exception
Exception
- if none of contained data sets can be converted to Excelvoid saveTo(AQExcelSpreadsheet spreadsheet) throws Exception
spreadsheet
-
Exception
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |