org.openlowcode.server.data.loader

Class FlatFileLoader<E extends DataObject<E> & UniqueidentifiedInterface<E>>

java.lang.Object

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

Type Parameters:

E - a DataObject

public class FlatFileLoader<E extends DataObject<E> & UniqueidentifiedInterface<E>>
extends java.lang.Object

A loader to get data from a flat file (CSV or Microsoft Excel)

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
FlatFileLoader(DataObjectDefinition<E> objectdefinition, ChoiceValue<ApplocaleChoiceDefinition> selectedlocale, ChoiceValue<PreferedfileencodingChoiceDefinition> preferedencoding) Creates a FlatFileLoader without supplement
FlatFileLoader(DataObjectDefinition<E> objectdefinition, ChoiceValue<ApplocaleChoiceDefinition> selectedlocale, ChoiceValue<PreferedfileencodingChoiceDefinition> preferedencoding, FlatFileLoaderSupplement<E> supplement) Creates a FlatFileLoader with a loader supplement

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildExceptionMessage(java.lang.Throwable t) Returns the error message
java.lang.String	dropOneLineAsText(java.lang.Object[] data)
CSVParser	generateCSVParser(SFile file, java.nio.charset.Charset charsettouse) generates a CSVParser for the file with the correct charset corresponding to the locale
ExcelReader	generateExcelParser(SFile file, java.lang.String preferedtab) generates an excel parser for the file
static java.time.format.DateTimeFormatter	generateFormat(java.lang.String inputformat, java.lang.String context) generates a DateTimeFormatter from a string input format
static boolean	hasdata(java.lang.Object[] parsedcsvline) This method returns true if the line has some data.
static <X> boolean	isTheSame(X object1, X object2) A helper method comparing without explosion two objects, taking into account the possibility that objects are null
static boolean	isWorkbookFormat(SFile file) checks if the file is a supported workbook format
FlatFileLoaderReport	load(SFile file) performs the 3 pass loading algorithm
static java.util.Date	parseDate(java.lang.Object object, java.lang.String context, boolean timeedit, java.time.format.DateTimeFormatter format) parses an object as a date
static java.math.BigDecimal	parseDecimal(java.lang.Object object, int precision, int scale, java.lang.String context, DecimalDataObjectFieldFlatFileLoaderColumn.DecimalParser decimalparser) parses a big decimal if possible, else throws an exception
static java.lang.Integer	parseInteger(java.lang.Object object, java.lang.String context) parses an object as Integer
static java.lang.String	parseObject(java.lang.Object object, java.lang.String context) parses an object as a string
static java.lang.String	parseStringStrict(java.lang.Object object, java.lang.String context)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatFileLoader

public FlatFileLoader(DataObjectDefinition<E> objectdefinition,
                      ChoiceValue<ApplocaleChoiceDefinition> selectedlocale,
                      ChoiceValue<PreferedfileencodingChoiceDefinition> preferedencoding)

Creates a FlatFileLoader without supplement

Parameters:

objectdefinition - definition of the object

selectedlocale - locale for CSV Loading

preferedencoding - preferred encoding for CSV Loading

FlatFileLoader

public FlatFileLoader(DataObjectDefinition<E> objectdefinition,
                      ChoiceValue<ApplocaleChoiceDefinition> selectedlocale,
                      ChoiceValue<PreferedfileencodingChoiceDefinition> preferedencoding,
                      FlatFileLoaderSupplement<E> supplement)

Creates a FlatFileLoader with a loader supplement

Parameters:

objectdefinition - definition of the object

selectedlocale - locale for CSV Loading

preferedencoding - prefered encoding for CSV Loading

supplement - supplement to the loader

Method Detail

hasdata

public static boolean hasdata(java.lang.Object[] parsedcsvline)

This method returns true if the line has some data. A data is defined as a string of length greater than 0

Parameters:

parsedcsvline -

Returns:

true of false depending on if the line has data.

buildExceptionMessage

public static java.lang.String buildExceptionMessage(java.lang.Throwable t)

Returns the error message

Parameters:

t - a throwable

Returns:

a String with the clearest possible message

isWorkbookFormat

public static boolean isWorkbookFormat(SFile file)

checks if the file is a supported workbook format

Parameters:

file - binary file

Returns:

true if supported workbook format (all variants of MS Excel today

generateCSVParser

public CSVParser generateCSVParser(SFile file,
                                   java.nio.charset.Charset charsettouse)

generates a CSVParser for the file with the correct charset corresponding to the locale

Parameters:

file - the file to generate the parser for

charsettouse - charset to use for the input stream

Returns:

a CSV Parser

generateExcelParser

public ExcelReader generateExcelParser(SFile file,
                                       java.lang.String preferedtab)

generates an excel parser for the file

Parameters:

file - binary file

preferedtab - name of the prefered tab to use

Returns:

the Excel Reader

load

public FlatFileLoaderReport load(SFile file)

performs the 3 pass loading algorithm

Parameters:

file - the file to use (loaded in memory)

Returns:

a report of the errors encountered

isTheSame

public static <X> boolean isTheSame(X object1,
                                    X object2)

A helper method comparing without explosion two objects, taking into account the possibility that objects are null

Parameters:

object1 - first object (can be null)

object2 - second object (can be null)

Returns:

true if same, false if different

parseObject

public static java.lang.String parseObject(java.lang.Object object,
                                           java.lang.String context)

parses an object as a string

Parameters:

object - the object

context - context for the parsing, used to give context in the potential exception

Returns:

a string with the canonical representation of the object

parseStringStrict

public static java.lang.String parseStringStrict(java.lang.Object object,
                                                 java.lang.String context)

Parameters:

object - object to parse (should be a String, else exception)

context - context for the exception being potentially thrown

Returns:

the object parsed as a string, or an exception

parseDate

public static java.util.Date parseDate(java.lang.Object object,
                                       java.lang.String context,
                                       boolean timeedit,
                                       java.time.format.DateTimeFormatter format)

parses an object as a date

Parameters:

object - the object to parse

context - context for potential exception being thrown

timeedit - true if time is stored in the date

format - format to parse the date if string

Returns:

the date if could be parsed as a valid date, else throws an exception

parseInteger

public static java.lang.Integer parseInteger(java.lang.Object object,
                                             java.lang.String context)

parses an object as Integer

Parameters:

object - an object (can be string or double)

context - context for exception throwing

Returns:

the integer parsed if operation could be succesfully achieved, else throws an exception

parseDecimal

public static java.math.BigDecimal parseDecimal(java.lang.Object object,
                                                int precision,
                                                int scale,
                                                java.lang.String context,
                                                DecimalDataObjectFieldFlatFileLoaderColumn.DecimalParser decimalparser)

parses a big decimal if possible, else throws an exception

Parameters:

object - the object to parse

precision - precision in the sense of BigDecimal

scale - scale in the sense of Big Decimal

context - context for exception throwing

decimalparser - a parser for the big decimal

Returns:

the Big Decimal if could be parsed, else throws an exception

generateFormat

public static java.time.format.DateTimeFormatter generateFormat(java.lang.String inputformat,
                                                                java.lang.String context)
                                                         throws java.lang.RuntimeException

generates a DateTimeFormatter from a string input format

Parameters:

inputformat - the input format to parse (if null, default format 'YYYY.MM.dd' is used)

context - context for exception handling

Returns:

the DateTimeFormatter

Throws:

java.lang.RuntimeException

dropOneLineAsText

public java.lang.String dropOneLineAsText(java.lang.Object[] data)
                                   throws java.lang.RuntimeException

Parameters:

data -

Returns:

Throws:

java.lang.RuntimeException