org.openlowcode.server.data.loader

Class FlatFileExtractor<E extends DataObject<E>>

java.lang.Object

org.openlowcode.server.data.loader.FlatFileExtractor<E>

Type Parameters:

E - data object this extractor applies to

public class FlatFileExtractor<E extends DataObject<E>>
extends java.lang.Object

an extractor to produce a spreadsheet file from a data object

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
FlatFileExtractor(DataObjectDefinition<E> definition) Creates a flat file extractor for the object

Method Summary

Modifier and Type	Method and Description
static org.apache.poi.ss.usermodel.CellStyle	createBorderedStyle(org.apache.poi.ss.usermodel.Workbook wb) a utility class to create style for a border around a cell
static org.apache.poi.ss.usermodel.CellStyle	createDateStyle(org.apache.poi.ss.usermodel.Workbook wb, java.lang.String simpledateformat) creates a style to show dates in the provided format
SFile	extractToExcel(E[] objectarray) extracts an array of objects to excel
SFile	extractToExcel(E[] objectarray, java.lang.String[] specificaliaslist)
SFile	extractToExcel(NodeTree<E> objecttree) Extracts to excel a tree of objects
static int	getCellNbChar(org.apache.poi.ss.usermodel.Cell cell) provides the number of characters needed for a cell
static int	maxNumberCharacter(java.lang.String multilinestring) provides the maximum number of characters of any line in the text
static void	setRestrictionsOnCell(org.apache.poi.ss.usermodel.Sheet mainsheet, org.apache.poi.ss.usermodel.Sheet restrictionsheet, int column, int nbofchoices, int nbofrows) create restrictions on the data cells

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatFileExtractor

public FlatFileExtractor(DataObjectDefinition<E> definition)

Creates a flat file extractor for the object

Parameters:

definition - the parent object

Method Detail

extractToExcel

public SFile extractToExcel(E[] objectarray,
                            java.lang.String[] specificaliaslist)

Parameters:

objectarray -

specificaliaslist -

Returns:

extractToExcel

public SFile extractToExcel(NodeTree<E> objecttree)

Extracts to excel a tree of objects

Parameters:

objecttree - object trees

Returns:

the binary file

extractToExcel

public SFile extractToExcel(E[] objectarray)

extracts an array of objects to excel

Parameters:

objectarray - the object array

Returns:

the binary file

getCellNbChar

public static int getCellNbChar(org.apache.poi.ss.usermodel.Cell cell)

provides the number of characters needed for a cell

Parameters:

cell - the cell to analyze

Returns:

number of characters

maxNumberCharacter

public static int maxNumberCharacter(java.lang.String multilinestring)

provides the maximum number of characters of any line in the text

Parameters:

multilinestring - a multi-line string

Returns:

the maximum number of characters

createBorderedStyle

public static org.apache.poi.ss.usermodel.CellStyle createBorderedStyle(org.apache.poi.ss.usermodel.Workbook wb)

a utility class to create style for a border around a cell

Parameters:

wb - the workbook

Returns:

the style to use to put border around a cell

createDateStyle

public static org.apache.poi.ss.usermodel.CellStyle createDateStyle(org.apache.poi.ss.usermodel.Workbook wb,
                                                                    java.lang.String simpledateformat)

creates a style to show dates in the provided format

Parameters:

wb - workbook

simpledateformat - format of the date

Returns:

the style to use

setRestrictionsOnCell

public static void setRestrictionsOnCell(org.apache.poi.ss.usermodel.Sheet mainsheet,
                                         org.apache.poi.ss.usermodel.Sheet restrictionsheet,
                                         int column,
                                         int nbofchoices,
                                         int nbofrows)

create restrictions on the data cells

Parameters:

mainsheet - sheet with data

restrictionsheet - sheet with restriction values

column - index of column (starting with zero)

nbofchoices - number of choices (starting with zero)

nbofrows - number of rows (starting with zero)