no.g9.client.spreadsheet

Class G9ExcelExporter

java.lang.Object

no.g9.client.spreadsheet.G9ExcelExporter

All Implemented Interfaces:

Serializable, Comparator<Object>, SpreadsheetExporter

public abstract class G9ExcelExporter
extends Object
implements SpreadsheetExporter, Comparator<Object>, Serializable

The class exports dialogs to Excel.

It serves as a super class for exporters which are tailored for specific dialog models.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<DialogObjectConstant,ExportElement>	elements Holds all the elements that is part of a dialog.

Constructor Summary

Constructors

Constructor and Description
G9ExcelExporter()

Method Summary

Modifier and Type	Method and Description
protected static void	autoResizeAll(org.apache.poi.ss.usermodel.Sheet sheet) Resize all columns according to the data, in all sheets from the workbook that contains the given sheet.
int	compare(Object o1, Object o2) Used to compare two list objects.
org.apache.poi.ss.usermodel.Workbook	createBook(ObjectSelection os, File workbook, WorkbookProvider.WORKBOOK_FORMAT bookFormat) Creates the workbook in the input file.
org.apache.poi.ss.usermodel.Workbook	createBook(ObjectSelection os, OutputStream workbook, WorkbookProvider.WORKBOOK_FORMAT bookFormat) Creates the workbook in the input file.
protected org.apache.poi.ss.usermodel.Cell	createCell(DialogObjectConstant dialogElement, org.apache.poi.ss.usermodel.Sheet sheet, G9ExcelCell offset, boolean isLabel, int colIndex, short alignment) Creates the cell for the element.
protected org.apache.poi.ss.usermodel.Cell	createCell(DialogObjectConstant dialogElement, org.apache.poi.ss.usermodel.Sheet sheet, G9ExcelCell offset, boolean isLabel, int colIndex, String columnTitle, short alignment) Creates the cell for the element.
protected org.apache.poi.ss.usermodel.Cell	createCell(DialogObjectConstant dialogElement, org.apache.poi.ss.usermodel.Sheet sheet, G9ExcelCell offset, boolean isLabel, short alignment) Creates a cell for the given element.
protected G9ExcelCell	createTable(ObjectSelection os, RoleConstant targetRole, List<TableColumnData> columnDataList, org.apache.poi.ss.usermodel.Sheet sheet, G9ExcelCell initialCell, boolean showHeader, DialogObjectConstant doc) Creates cells for a table.
protected abstract void	exportDialog(ObjectSelection os, org.apache.poi.ss.usermodel.Sheet defaultSheet) Initialization of the export.
protected abstract ResourceBundle	getBundle() Gets the resource bundle.
protected static Object	getChildObject(Object parent, OSRole<?> parentRole, RoleConstant childRole) Gets the child object(s) from parent.
protected Object	getColumnObject(Object targetObject, RoleConstant attributeRole) Gets the column object.
protected static short	getColumns(org.apache.poi.ss.usermodel.Sheet sheet) Get the (maximum) number of columns in use for a sheet.
protected abstract String	getDialogName() Retrieves the dialog name.
protected Object	getDomainObjectFromParent(Object parentObject, RoleConstant targetRole) Gets the domain object(s) from the parent domain object
protected static ResourceBundle	getGeneralBundle() Gets the application resource bundle.
protected static G9ExcelCell	getMax(G9ExcelCell[] cells) Creates a G9ExcelCell with max column and row.
protected static G9ExcelCell	getMax(G9ExcelCell offset, G9ExcelCell cell) Creates a G9ExcelCell with max column and row.
protected G9ExcelCell	getMaxCell(DialogObjectConstant[] dialogElements, G9ExcelCell offset) Gets the maximum cell obtained when combining the provided offset with one of the dialog elements
protected G9ExcelCell	getNextAvailableCell(DialogObjectConstant[] dialogElements, G9ExcelCell offset) Gets the next available cell.
protected abstract boolean	getParameterHidden() Gets the generator parameter that tells whether the user want to show hidden elements or not.
protected static List<OSRole<?>>	getRoleHierarchy(OSRole<?> targetRole) Gets the role hierarchy from target to root.
protected abstract Map<RoleConstant,OSRole<?>>	getRoleMap() Gives a map of role constants and object selection roles.
protected Object	getRootObject(ObjectSelection os, RoleConstant targetRole) Gets the root object(s) for the target role from an object selection
Object	getRootOrTargetObject(ObjectSelection os, RoleConstant targetRole, String compare) Make sure that the use of getRootObject is not used, when the Root Object is not wanted.
protected static org.apache.poi.ss.usermodel.Row	getRow(org.apache.poi.ss.usermodel.Sheet sheet, int localRow, int offset) Retrieves the row with the given data.
protected abstract String	getSheetName() Gets the sheet name.
protected List<Object>	getSortedTargetObjects(ObjectSelection os, RoleConstant targetRole) Retrieves a sorted list of the data.
protected Object	getTargetObject(ObjectSelection os, RoleConstant targetRole) Gets the target object from the object selection.
org.apache.poi.ss.usermodel.Workbook	getWorkbook() Gets the result workbook.
WorkbookProvider	getWorkbookProvider() Get the workbook provider.
protected static boolean	hookFilterElement(DialogObjectConstant dialogElement, Object domainObject) Lets user code filter the data for this dialog element.
protected abstract void	setAllMapElements() Sets all the DialogObjectConstant elements in the map.
protected void	setCellData(DialogObjectConstant dialogElement, Object domainObject, org.apache.poi.ss.usermodel.Cell cell, String dateFormat) Adds data to a specific cell.
protected void	setLabelAsBold(boolean val) Sets the labelAsBold variable.
void	setWorkbookProvider(WorkbookProvider workbookProvider) Set a new workbook provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

elements

protected Map<DialogObjectConstant,ExportElement> elements

Holds all the elements that is part of a dialog.

Constructor Detail

G9ExcelExporter

public G9ExcelExporter()

Method Detail

getWorkbookProvider

public WorkbookProvider getWorkbookProvider()

Get the workbook provider.

If it is not set, a new workbook provider is created.

Returns:

the current workbook provider

setWorkbookProvider

public void setWorkbookProvider(WorkbookProvider workbookProvider)

Set a new workbook provider.

Parameters:

workbookProvider - the new workbook provider

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

Gets the result workbook.

Specified by:

getWorkbook in interface SpreadsheetExporter

Returns:

final product

setLabelAsBold

protected void setLabelAsBold(boolean val)

Sets the labelAsBold variable.

Parameters:

val - a boolean value telling whether labels should be created as bold in the excel document or not

createBook

public org.apache.poi.ss.usermodel.Workbook createBook(ObjectSelection os,
                                                       File workbook,
                                                       WorkbookProvider.WORKBOOK_FORMAT bookFormat)

Creates the workbook in the input file.

Parameters:

os - the data to export

workbook - the target workbook

bookFormat - the format, i.e. xls vs. xlsx

Returns:

A workbook with a name specified in DefaultExcelExporter, which is a generated class for a specific dialog model

createBook

public org.apache.poi.ss.usermodel.Workbook createBook(ObjectSelection os,
                                                       OutputStream workbook,
                                                       WorkbookProvider.WORKBOOK_FORMAT bookFormat)

Creates the workbook in the input file.

Parameters:

os - the data to export

workbook - the target workbook

bookFormat - the format, i.e. xls vs. xlsx

Returns:

A workbook with a name specified in DefaultExcelExporter, which is a generated class for a specific dialog model

exportDialog

protected abstract void exportDialog(ObjectSelection os,
                                     org.apache.poi.ss.usermodel.Sheet defaultSheet)

Initialization of the export.

Parameters:

os - the data

defaultSheet - the default sheet

setAllMapElements

protected abstract void setAllMapElements()

Sets all the DialogObjectConstant elements in the map.

getSheetName

protected abstract String getSheetName()

Gets the sheet name.

Returns:

the name of the Sheet

getParameterHidden

protected abstract boolean getParameterHidden()

Gets the generator parameter that tells whether the user want to show hidden elements or not.

Returns:

true if one wants to show hidden elements, and false else

getDialogName

protected abstract String getDialogName()

Retrieves the dialog name.

Returns:

the dialog name

createCell

protected org.apache.poi.ss.usermodel.Cell createCell(DialogObjectConstant dialogElement,
                                                      org.apache.poi.ss.usermodel.Sheet sheet,
                                                      G9ExcelCell offset,
                                                      boolean isLabel,
                                                      short alignment)

Creates a cell for the given element.

Parameters:

dialogElement - the element to create

sheet - the sheet to create the element in

offset - the global offset for the cell

isLabel - indicates if the cell should hold a label

alignment - the specified alignment

Returns:

the cell with correct alignment

createCell

protected org.apache.poi.ss.usermodel.Cell createCell(DialogObjectConstant dialogElement,
                                                      org.apache.poi.ss.usermodel.Sheet sheet,
                                                      G9ExcelCell offset,
                                                      boolean isLabel,
                                                      int colIndex,
                                                      short alignment)

Creates the cell for the element. Uses custom column index.

Parameters:

dialogElement - the element to create

sheet - the sheet to create the element in

offset - the global offset for the cell

isLabel - indicates if the cell should hold a label

colIndex - used in some special cases to indicate start column

alignment - the specified alignment

Returns:

the cell with correct alignment

createCell

protected org.apache.poi.ss.usermodel.Cell createCell(DialogObjectConstant dialogElement,
                                                      org.apache.poi.ss.usermodel.Sheet sheet,
                                                      G9ExcelCell offset,
                                                      boolean isLabel,
                                                      int colIndex,
                                                      String columnTitle,
                                                      short alignment)

Creates the cell for the element. Uses custom column index and column title.

Parameters:

dialogElement - the element to create

sheet - the sheet to create the element in

offset - the global offset for the cell

isLabel - indicates if the cell should hold a label

colIndex - used in some special cases to indicate start column. The value -1 signals it is not to be used

columnTitle - used to name a cell in case the DialogObjectConstant is not able to provide a string

alignment - the specified alignment

Returns:

The cell with correct alignment

createTable

protected G9ExcelCell createTable(ObjectSelection os,
                                  RoleConstant targetRole,
                                  List<TableColumnData> columnDataList,
                                  org.apache.poi.ss.usermodel.Sheet sheet,
                                  G9ExcelCell initialCell,
                                  boolean showHeader,
                                  DialogObjectConstant doc)

Creates cells for a table.

Parameters:

os - the data

targetRole - the primary role for the table

columnDataList - a list containing data about each column

sheet - the Sheet in which the table should be added to

initialCell - the offset before creating the table

showHeader - tells whether the columns headers should be shown

doc - the DialogObjectConstant

Returns:

The offset when the table is created

getColumnObject

protected Object getColumnObject(Object targetObject,
                                 RoleConstant attributeRole)

Gets the column object.

Parameters:

targetObject - contains data about role attributes

attributeRole - some role constant belonging to the current column

Returns:

the column object

getSortedTargetObjects

protected List<Object> getSortedTargetObjects(ObjectSelection os,
                                              RoleConstant targetRole)

Retrieves a sorted list of the data.

Typically to be used in lists (list blocks and table blocks).

Parameters:

os - the data

targetRole - the target role

Returns:

a List of target objects. An empty list if no target objects

setCellData

protected void setCellData(DialogObjectConstant dialogElement,
                           Object domainObject,
                           org.apache.poi.ss.usermodel.Cell cell,
                           String dateFormat)

Adds data to a specific cell.

Parameters:

dialogElement - the dialog element

domainObject - the domain object

cell - the cell to put the data in

dateFormat - the format for dates

getTargetObject

protected Object getTargetObject(ObjectSelection os,
                                 RoleConstant targetRole)

Gets the target object from the object selection.

The operation will only navigate over single relations from parent to child.

Parameters:

os - the data

targetRole - the target role

Returns:

the domain object for the role, null if none

getRootOrTargetObject

public Object getRootOrTargetObject(ObjectSelection os,
                                    RoleConstant targetRole,
                                    String compare)

Make sure that the use of getRootObject is not used, when the Root Object is not wanted.

Parameters:

os - the ObjectSelection

targetRole - the target role

compare - the compare string

Returns:

the root object(s) for the target role or the domain object for the role. Null if none

getChildObject

protected static Object getChildObject(Object parent,
                                       OSRole<?> parentRole,
                                       RoleConstant childRole)

Gets the child object(s) from parent.

Parameters:

parent - the parent object

parentRole - the parent role

childRole - the role constant to get the object for

Returns:

the child object(s)

getRoleHierarchy

protected static List<OSRole<?>> getRoleHierarchy(OSRole<?> targetRole)

Gets the role hierarchy from target to root.

Parameters:

targetRole - the target role

Returns:

a List of roles from target (first) to root (last). Empty list if targetRole is null

hookFilterElement

protected static boolean hookFilterElement(DialogObjectConstant dialogElement,
                                           Object domainObject)

Lets user code filter the data for this dialog element.

Parameters:

dialogElement - the dialog element

domainObject - the domain object

Returns:

true to filter the dialog element, otherwise false

getRow

protected static org.apache.poi.ss.usermodel.Row getRow(org.apache.poi.ss.usermodel.Sheet sheet,
                                                        int localRow,
                                                        int offset)

Retrieves the row with the given data.

Creates a new if it doesn't exist already.

Parameters:

sheet - the addressed sheet

localRow - the row number

offset - the offset

Returns:

the row in interest

getMax

protected static G9ExcelCell getMax(G9ExcelCell[] cells)

Creates a G9ExcelCell with max column and row.

Parameters:

cells - some array containing G9ExcelCells

Returns:

the cell with max column and row, found among the provided G9ExcelCells

getMax

protected static G9ExcelCell getMax(G9ExcelCell offset,
                                    G9ExcelCell cell)

Creates a G9ExcelCell with max column and row.

Parameters:

offset - the initial cell

cell - the new cell

Returns:

the cell with max column and row, based on the provided G9ExcelCells

getMaxCell

protected G9ExcelCell getMaxCell(DialogObjectConstant[] dialogElements,
                                 G9ExcelCell offset)

Gets the maximum cell obtained when combining the provided offset with one of the dialog elements

Parameters:

dialogElements - the dialog elements to consider

offset - the maximum cell before dialog elements are added

Returns:

the maximum cell obtained when combining the provided offset with one of the dialog elements

getRootObject

protected Object getRootObject(ObjectSelection os,
                               RoleConstant targetRole)

Gets the root object(s) for the target role from an object selection

Parameters:

os - the object selection (data)

targetRole - the target role

Returns:

the root object(s) of the target role

getDomainObjectFromParent

protected Object getDomainObjectFromParent(Object parentObject,
                                           RoleConstant targetRole)

Gets the domain object(s) from the parent domain object

Parameters:

parentObject - the parent domain object

targetRole - the target role

Returns:

domain object(s) of the target (if the parent object matches the parent role)

getRoleMap

protected abstract Map<RoleConstant,OSRole<?>> getRoleMap()

Gives a map of role constants and object selection roles.

Returns:

a Map from role constant to object selection role

getBundle

protected abstract ResourceBundle getBundle()

Gets the resource bundle.

Returns:

the resource bundle

getGeneralBundle

protected static ResourceBundle getGeneralBundle()

Gets the application resource bundle.

Returns:

the application resource bundle

getNextAvailableCell

protected G9ExcelCell getNextAvailableCell(DialogObjectConstant[] dialogElements,
                                           G9ExcelCell offset)

Gets the next available cell.

Almost like getMaxCell, but the returned cell does not necessary contain the highest column index possible. Instead, the maximum column index on the row having the highest row index, is used.

Parameters:

dialogElements - the dialog elements to consider

offset - the maximum cell before dialog elements are added

Returns:

a new cell containing the highest row index and the column index which is highest on that row

compare

public int compare(Object o1,
                   Object o2)

Used to compare two list objects.

Uses the OS Role Map to get the target objects value. The target objects values are then compared using their compareTo-method.

Specified by:

compare in interface Comparator<Object>

Parameters:

o1 - a target object

o2 - also a target object

Returns:

1 if o1 > o2, 0 if o1 == o2 and -1 if o1 < o2

getColumns

protected static short getColumns(org.apache.poi.ss.usermodel.Sheet sheet)

Get the (maximum) number of columns in use for a sheet.

Parameters:

sheet - the sheet with data

Returns:

the number of columns in use

autoResizeAll

protected static void autoResizeAll(org.apache.poi.ss.usermodel.Sheet sheet)

Resize all columns according to the data, in all sheets from the workbook that contains the given sheet.

Parameters:

sheet - a Sheet contained within the workbook where all cells are going to be resized