com.groiss.reporting.export

Interface ReportingExporter

All Known Subinterfaces:

ClientSideExporter, FileReportingExporter<T>

All Known Implementing Classes:

DelimiterSeperatedValuesExporter, DownloadExporter, HTMLExporter

public interface ReportingExporter

Interface of Reporting Exporter. Implement this interface if another export format is needed

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayList<Pair<String,String>>	ROW_STYLE_HIDDEN

Method Summary

Modifier and Type	Method and Description
default void	addConfigOptions(Query q, XHTMLPage p) Deprecated. since 9.0
default void	export(HttpServletResponse res, Query q, ReportingTableModel tm) Deprecated.
String	getExportName()
JSONArray	getExportOptionsJSON() add configureable fields...

Field Detail

ROW_STYLE_HIDDEN

static final ArrayList<Pair<String,String>> ROW_STYLE_HIDDEN

Method Detail

getExportName

String getExportName()

Returns:

the I18N name of the exporter

addConfigOptions

@Deprecated
default void addConfigOptions(Query q,
                                          XHTMLPage p)

Deprecated. since 9.0

Method is called for all configured exporter. Add fields to XHMTLPage to enable configuration settings. Id of field will be the key of the Exportparameter.

Parameters:

q - the query Object

p - the XHTMLPage for ExportOptions

export

@Deprecated
default void export(HttpServletResponse res,
                                Query q,
                                ReportingTableModel tm)

Deprecated.

exports the table model

Parameters:

res - the Response of the report request

q - the executed Query

tm - The result Tablemodel

getExportOptionsJSON

JSONArray getExportOptionsJSON()
                        throws JSONException

add configureable fields...

Returns:

jsonarray which contains jsonobjects which have at leaast an id, a label and an implementing widget

Throws:

JSONException