com.groiss.reporting.export

Class HTMLExporter

java.lang.Object

com.groiss.reporting.export.HTMLExporter

All Implemented Interfaces:

ClientSideExporter, ReportingExporter

Direct Known Subclasses:

DownloadExporter

public class HTMLExporter
extends Object
implements ClientSideExporter

Exports Query results to HTML. Uses TableRenderer to display result Table.

Field Summary

Fields inherited from interface com.groiss.reporting.export.ReportingExporter

ROW_STYLE_HIDDEN

Constructor Summary

Constructors

Constructor and Description
HTMLExporter()

Method Summary

Modifier and Type	Method and Description
void	addConfigOptions(Query q, XHTMLPage p) Deprecated.
void	export(HttpServletResponse res, Query q, ReportingTableModel tm) Deprecated.
protected ReportingTableModel	generateMatrixTable(ReportingTableModel tm, Query q)
String	getClientSideRenderer()
protected Component	getComponentData(Query q, ReportingTableModel tm) Deprecated.
String	getExportName()
JSONArray	getExportOptionsJSON() add configureable fields...
protected Map<String,String>	getHeaderInfos(Query q, int count)
protected String	getId() Deprecated.
KeyedList<Integer,String>	getLineStyles(Query q, ReportingTableModel tm) Deprecated.
HTMLPage	getPage(Query q) Deprecated.
JSONArray	getResultDetailsJson(Query q, int count)
protected TableModel	getResultTableModel(Query q, ReportingTableModel tm) Deprecated.
protected String	getToolbarActions(Query q) Deprecated.
static boolean	isJsonExport() if the new GUI is used, data is transmitted using JSON and HTML should be created on the clientside.
List<Map<String,Object>>	toJson(Query q, ReportingTableModel tm)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLExporter

public HTMLExporter()

Method Detail

getId

@Deprecated
protected String getId()

Deprecated.

addConfigOptions

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

Deprecated.

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.

Specified by:

addConfigOptions in interface ReportingExporter

Parameters:

q - the query Object

p - the XHTMLPage for ExportOptions

getExportOptionsJSON

public JSONArray getExportOptionsJSON()

Description copied from interface: ReportingExporter

add configureable fields...

Specified by:

getExportOptionsJSON in interface ReportingExporter

Returns:

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

getPage

@Deprecated
public HTMLPage getPage(Query q)

Deprecated.

Returns the configured HTML Page...

Parameters:

q - the specified query

Returns:

the page containing wildcards for additional scripts and the data.

getExportName

public String getExportName()

Specified by:

getExportName in interface ReportingExporter

Returns:

the I18N name of the exporter

export

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

Deprecated.

exports the table model

Specified by:

export in interface ReportingExporter

Parameters:

res - the Response of the report request

q - the executed Query

tm - The result Tablemodel

getToolbarActions

@Deprecated
protected String getToolbarActions(Query q)

Deprecated.

getComponentData

@Deprecated
protected Component getComponentData(Query q,
                                                 ReportingTableModel tm)

Deprecated.

getResultTableModel

@Deprecated
protected TableModel getResultTableModel(Query q,
                                                     ReportingTableModel tm)

Deprecated.

Returns a tablemodel that the TableRenderer may handle. Overwrite this method if the exporter should display the results in html to ensure compatibility with toolbar actions

Parameters:

q - The query object

tm - The Reporting results return a Tablemodel implementation that the TableRenderer is able to transform to a TableContainer.

getHeaderInfos

protected Map<String,String> getHeaderInfos(Query q,
                                            int count)

Parameters:

q - the Query objects

count - the number of results of report

Returns:

a Map with the Info params. The key is the I18N key of the info paramters, the value the configured value

isJsonExport

public static boolean isJsonExport()

if the new GUI is used, data is transmitted using JSON and HTML should be created on the clientside. this method returns true if a JsonExporter is used, and therefore custom ReportingExportable.toHtml() could omit returning HTML. ReportingExportable.toHtml() is still called because of compatibility

Returns:

getLineStyles

@Deprecated
public KeyedList<Integer,String> getLineStyles(Query q,
                                                           ReportingTableModel tm)

Deprecated.

getClientSideRenderer

public String getClientSideRenderer()

Specified by:

getClientSideRenderer in interface ClientSideExporter

generateMatrixTable

protected ReportingTableModel generateMatrixTable(ReportingTableModel tm,
                                                  Query q)

toJson

public List<Map<String,Object>> toJson(Query q,
                                       ReportingTableModel tm)

Specified by:

toJson in interface ClientSideExporter

getResultDetailsJson

public JSONArray getResultDetailsJson(Query q,
                                      int count)

Specified by:

getResultDetailsJson in interface ClientSideExporter