com.groiss.reporting.export

Class HTMLExporter

java.lang.Object

com.groiss.reporting.export.HTMLExporter

All Implemented Interfaces:

com.groiss.reporting.export.ClientSideExporter, ReportingExporter

Direct Known Subclasses:

DownloadExporter

public class HTMLExporter
extends java.lang.Object
implements ReportingExporter, com.groiss.reporting.export.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

Methods

Modifier and Type	Method and Description
void	addConfigOptions(Query q, XHTMLPage p) Deprecated.
void	export(javax.servlet.http.HttpServletResponse res, Query q, ReportingTableModel tm) exports the table model
static SelectList	getAttributeDropdownlist(Query q, boolean addEmptyOption) Returns SelectList containing the available Attributes and their ids.
java.lang.String	getClientSideRenderer()
protected Component	getComponentData(Query q, ReportingTableModel tm)
java.lang.String	getExportName()
org.json.JSONArray	getExportOptionsJSON() add configureable fields...
protected java.util.Map<java.lang.String,java.lang.String>	getHeaderInfos(Query q, int count)
protected java.lang.String	getId()
KeyedList<java.lang.Integer,java.lang.String>	getLineStyles(Query q, ReportingTableModel tm)
HTMLPage	getPage(Query q) Returns the configured HTML Page...
org.json.JSONArray	getResultDetailsJson(Query q, int count)
protected javax.swing.table.TableModel	getResultTableModel(Query q, ReportingTableModel tm) Returns a tablemodel that the TableRenderer may handle.
protected java.lang.String	getToolbarActions(Query q)
java.util.List<java.util.Map<java.lang.String,java.lang.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

protected java.lang.String getId()

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 org.json.JSONArray getExportOptionsJSON()
                                        throws org.json.JSONException

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

Throws:

org.json.JSONException

getPage

public HTMLPage getPage(Query q)

Returns the configured HTML Page...

Parameters:

q - the specified query

Returns:

the page containing wildcards for additional scripts and the data.

getExportName

public java.lang.String getExportName()

Specified by:

getExportName in interface ReportingExporter

Returns:

the I18N name of the exporter

export

public void export(javax.servlet.http.HttpServletResponse res,
          Query q,
          ReportingTableModel tm)

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

protected java.lang.String getToolbarActions(Query q)

getComponentData

protected Component getComponentData(Query q,
                         ReportingTableModel tm)

getResultTableModel

protected javax.swing.table.TableModel getResultTableModel(Query q,
                                               ReportingTableModel tm)

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 java.util.Map<java.lang.String,java.lang.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

getAttributeDropdownlist

public static SelectList getAttributeDropdownlist(Query q,
                                  boolean addEmptyOption)

Returns SelectList containing the available Attributes and their ids. Needed for options pages

Parameters:

q - the query Object

addEmptyOption - - pas true if selectlist shall include an empty option

Returns:

the filled select list, no name or id is set

getLineStyles

public KeyedList<java.lang.Integer,java.lang.String> getLineStyles(Query q,
                                                          ReportingTableModel tm)

getClientSideRenderer

public java.lang.String getClientSideRenderer()

Specified by:

getClientSideRenderer in interface com.groiss.reporting.export.ClientSideExporter

toJson

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> toJson(Query q,
                                                                      ReportingTableModel tm)
                                                                        throws org.json.JSONException

Specified by:

toJson in interface com.groiss.reporting.export.ClientSideExporter

Throws:

org.json.JSONException

getResultDetailsJson

public org.json.JSONArray getResultDetailsJson(Query q,
                                      int count)
                                        throws org.json.JSONException

Specified by:

getResultDetailsJson in interface com.groiss.reporting.export.ClientSideExporter

Throws:

org.json.JSONException