com.groiss.reporting.export

Class DownloadExporter<T>

java.lang.Object

com.groiss.reporting.export.HTMLExporter

com.groiss.reporting.export.DownloadExporter<T>

All Implemented Interfaces:

ClientSideExporter, FileReportingExporter<T>, ReportingExporter

Direct Known Subclasses:

DelimiterSeperatedValuesExporter

public abstract class DownloadExporter<T>
extends HTMLExporter
implements FileReportingExporter<T>

Abstract subclass of HTMLExporter. Implement this class to provide export object as download. Class provides methods to download

Field Summary

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

ROW_STYLE_HIDDEN

Constructor Summary

Constructors

Constructor and Description
DownloadExporter()

Method Summary

Modifier and Type	Method and Description
void	download(HttpServletRequest req, HttpServletResponse res) Implement this method to provide download.
String	getClientSideRenderer()
protected Object	getData(Query q, ReportingTableModel tm) Deprecated. since version 9.0, Use getDataObject
byte[]	getDataBytes(T dataObject) Deprecated. since 9.0 use getDataStream
abstract T	getDataObject(Query q, ReportingTableModel tm) returns the Object which is generated by this Exporter called by abstract Class DownloadExpoerter
InputStream	getDataStream(Query q, ReportingTableModel tm)
JSONArray	getExportOptionsJSON() add configureable fields...
protected String	getFileName() gets the filename from the request or the session
protected String	getFileName(Query q)
protected TableModel	getResultTableModel(Query q, ReportingTableModel tm) Deprecated.
List<Map<String,Object>>	toJson(Query q, ReportingTableModel tm)

Methods inherited from class com.groiss.reporting.export.HTMLExporter

addConfigOptions, export, generateMatrixTable, getComponentData, getExportName, getHeaderInfos, getId, getLineStyles, getPage, getResultDetailsJson, getToolbarActions, isJsonExport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groiss.reporting.export.FileReportingExporter

getFileTypeExtension

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

addConfigOptions, export, getExportName

Constructor Detail

DownloadExporter

public DownloadExporter()

Method Detail

getFileName

protected final String getFileName()

gets the filename from the request or the session

getFileName

protected String getFileName(Query q)

getResultTableModel

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

Deprecated.

Description copied from class: HTMLExporter

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

Overrides:

getResultTableModel in class HTMLExporter

Parameters:

q - The query object

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

toJson

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

Specified by:

toJson in interface ClientSideExporter

Overrides:

toJson in class HTMLExporter

getClientSideRenderer

public String getClientSideRenderer()

Specified by:

getClientSideRenderer in interface ClientSideExporter

Overrides:

getClientSideRenderer in class HTMLExporter

getData

@Deprecated
protected Object getData(Query q,
                                     ReportingTableModel tm)

Deprecated. since version 9.0, Use getDataObject

Parameters:

q -

tm -

Returns:

getDataStream

public InputStream getDataStream(Query q,
                                 ReportingTableModel tm)

Specified by:

getDataStream in interface FileReportingExporter<T>

getDataObject

public abstract T getDataObject(Query q,
                                ReportingTableModel tm)

returns the Object which is generated by this Exporter called by abstract Class DownloadExpoerter

Parameters:

q - the executed query

tm - the result tablemodel

Returns:

the object representing - mostly a path to a temp file

getDataBytes

@Deprecated
public byte[] getDataBytes(T dataObject)

Deprecated. since 9.0 use getDataStream

transforms Dataobject to byte array.

Parameters:

dataObject - the result of getDataObject

Returns:

the byte array of the file

download

public void download(HttpServletRequest req,
                     HttpServletResponse res)

Implement this method to provide download. Obtain a timestamp from request paramteter time and retrieve the queryid and the data object of the getData method HttpSession Paramters "queryid"+timestamp and "querydata"+timestamp Note: Set the correct Contenttype and length of response.

Parameters:

req - the download request

res - the resonse object

getExportOptionsJSON

public JSONArray getExportOptionsJSON()

Description copied from interface: ReportingExporter

add configureable fields...

Specified by:

getExportOptionsJSON in interface ReportingExporter

Overrides:

getExportOptionsJSON in class HTMLExporter

Returns:

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