no.g9.client.spreadsheet

Class DefaultSpreadsheetService

java.lang.Object

no.g9.client.spreadsheet.DefaultSpreadsheetService

All Implemented Interfaces:

SpreadsheetService

public class DefaultSpreadsheetService
extends Object
implements SpreadsheetService

The default implementation of the SpreadsheetService interface. It will use a generated G9ExcelExporter subclass for the spreadsheet export.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT_PARAM The ClientContext parameter name for the Excel format to use.

Constructor Summary

Constructors

Constructor and Description
DefaultSpreadsheetService()

Method Summary

Modifier and Type	Method and Description
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, File file) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, File file, ClientContext ctx) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, OutputStream outputStream) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, OutputStream outputStream, ClientContext ctx) Export data from the given dialog to a spreadsheet.
protected G9ExcelExporter	getExporter(ObjectSelection os, DialogConstant targetDialog) Get the Excel exporter to use for the spreadsheet export.
String	getFileSuffix()
String	getMimeType()
protected void	parseParams(ClientContext ctx) Check if the client context contains any parameters used by the Excel exporter.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_PARAM

public static final String FORMAT_PARAM

The ClientContext parameter name for the Excel format to use.

See Also:

Constant Field Values

Constructor Detail

DefaultSpreadsheetService

public DefaultSpreadsheetService()

Method Detail

exportToSpreadsheet

public SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                               DialogConstant targetDialog,
                                               File file)

Description copied from interface: SpreadsheetService

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Specified by:

exportToSpreadsheet in interface SpreadsheetService

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

file - The resulting spreadsheet file

Returns:

An object containing the exported workbook

exportToSpreadsheet

public SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                               DialogConstant targetDialog,
                                               OutputStream outputStream)

Description copied from interface: SpreadsheetService

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Specified by:

exportToSpreadsheet in interface SpreadsheetService

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

outputStream - The output stream for the exported data

Returns:

An object containing the exported workbook

exportToSpreadsheet

public SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                               DialogConstant targetDialog,
                                               File file,
                                               ClientContext ctx)

Description copied from interface: SpreadsheetService

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Specified by:

exportToSpreadsheet in interface SpreadsheetService

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

file - The resulting spreadsheet file

ctx - The client context, which may be used to send exporter parameters

Returns:

An object containing the exported workbook

exportToSpreadsheet

public SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                               DialogConstant targetDialog,
                                               OutputStream outputStream,
                                               ClientContext ctx)

Description copied from interface: SpreadsheetService

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Specified by:

exportToSpreadsheet in interface SpreadsheetService

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

outputStream - The output stream for the exported data

ctx - The client context, which may be used to send exporter parameters

Returns:

An object containing the exported workbook

getFileSuffix

public String getFileSuffix()

Specified by:

getFileSuffix in interface SpreadsheetService

Returns:

the file suffix used for the exported data

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface SpreadsheetService

Returns:

the MIME type used for the exported data

parseParams

protected void parseParams(ClientContext ctx)

Check if the client context contains any parameters used by the Excel exporter.
The Excel exporter can generate exports with both XLS and XLSX formats. The default is XLSX, but XLS will be used if the FORMAT_PARAM is set to WORKBOOK_FORMAT.XLS.
If the SpreadsheetService was called from a generated ExportToSpreadsheet action, parameters can be added to the client context in the contextHook method of an ActionHookAdapter.
This method can be overridden in a subclass if using a spreadsheet exporter which supports other parameters.

Parameters:

ctx - The client context object

getExporter

protected G9ExcelExporter getExporter(ObjectSelection os,
                                      DialogConstant targetDialog)

Get the Excel exporter to use for the spreadsheet export.
The default is to first check if there is a property file named "ApplicationName".spreadsheetExporter with a "DialogName" property. If found, the property value should be the class name of the exporter.
Else, the property ServiceApplication."ApplicationName".DefaultSpreadsheetExporterPackage is used as the package prefix for the exporter class, appended with the package of the dialog and the "DialogName"ExcelExporter to get the exporter class name.
This method can be overridden in a subclass if another spreadsheet exporter lookup method is wanted.

Parameters:

os - The object selection, with the name of the object selection

targetDialog - The dialog to be exported

Returns:

The Excel exporter to use for the spreadsheet export