de.must.io

Class CSVImport

java.lang.Object

de.must.middle.ExemptibleManagerImplementation

de.must.io.CSVImport

All Implemented Interfaces:

Exemptible, ExemptibleManager

public abstract class CSVImport
extends ExemptibleManagerImplementation

Import from CSV files with check of mandatory columns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CSVImport.NoDataFoundException

Field Summary

Fields

Modifier and Type	Field and Description
protected AliveConfirmer	aliveConfirmer
protected DataObjectConstructionDetails	docd Data object construction details to use
protected int	importCount
protected int	maxImport
static java.lang.String[]	openAlterNatives
protected char[]	preferredDelimiter
protected SessionResources	sessionResources
protected StatusInfoPresenter	statusInfoPresenter

Constructor Summary

Constructors

Constructor and Description
CSVImport(SessionResources sessionResources)

Method Summary

Modifier and Type	Method and Description
void	checkFile(java.io.BufferedReader bure, java.lang.String[] mandatoryColumnNames)
void	checkFile(java.io.BufferedReader bure, java.lang.String[][] mandatoryColumnNameAlternatives)
java.lang.String	checkFile(java.lang.String filePath, java.lang.String[] mandatoryColumnNames)
java.lang.String	checkFile(java.lang.String filePath, java.lang.String[][] mandatoryColumnNameAlternatives) Checks the file and returns the suitable charset name to read it.
protected boolean	checkFile(java.lang.String filePath, java.lang.String[][] mandatoryColumnNameAlternatives, java.lang.String charsetName)
java.lang.String	checkFile(java.lang.String filePath, java.lang.String[] mandatoryColumnNames, java.lang.String charsetName) Returns the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid.
java.lang.String	checkFileReturnCharset(java.lang.String filePath, java.lang.String[][] mandatoryColumnNameAlternatives, java.lang.String charsetName) Returns the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid.
java.lang.String	chooseSuitableCharsetFrom(java.lang.String filePath, java.lang.String[] charsetOptions) Returns a suitable charset name to read the file, trying in the order of charsetOptions.
int	getImportAmount()
static java.lang.String	getMessage(java.lang.String[] mandatoryColumnNames)
static java.lang.String	getMessage(java.lang.String[][] mandatoryColumnNameAlternatives)
java.lang.String	getMessageWhatsMissing() Returns message what's explicitly missing in first row, which is easer to understand for user than complete message of NoDataFoundException.
protected char	guessDelimiter(java.io.BufferedReader bure)
protected char	guessDelimiter(java.lang.String firstLine)
void	setAliveConfirmer(AliveConfirmer aliveConfirmer)
void	setDataObjectConstructionDetails(DataObjectConstructionDetails docd)
void	setMaxImport(int maxImport) Sets the maximum of entries to be imported
void	setPreferredDelimiter(char[] preferredDelimiter)
void	setStatusInfoPresenter(StatusInfoPresenter statusInfoPresenter)
protected void	setStatusInformation(java.lang.String info)

Methods inherited from class de.must.middle.ExemptibleManagerImplementation

free, register

Methods inherited from class java.lang.Object

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

Field Detail

sessionResources

protected SessionResources sessionResources

docd

protected DataObjectConstructionDetails docd

Data object construction details to use

aliveConfirmer

protected AliveConfirmer aliveConfirmer

preferredDelimiter

protected char[] preferredDelimiter

statusInfoPresenter

protected StatusInfoPresenter statusInfoPresenter

maxImport

protected int maxImport

importCount

protected int importCount

openAlterNatives

public static java.lang.String[] openAlterNatives

Constructor Detail

CSVImport

public CSVImport(SessionResources sessionResources)

Method Detail

getMessage

public static java.lang.String getMessage(java.lang.String[] mandatoryColumnNames)

getMessage

public static java.lang.String getMessage(java.lang.String[][] mandatoryColumnNameAlternatives)

setDataObjectConstructionDetails

public void setDataObjectConstructionDetails(DataObjectConstructionDetails docd)

setStatusInfoPresenter

public void setStatusInfoPresenter(StatusInfoPresenter statusInfoPresenter)

setMaxImport

public void setMaxImport(int maxImport)

Sets the maximum of entries to be imported

Parameters:

maxImport - the maximum of entries to be imported

setAliveConfirmer

public void setAliveConfirmer(AliveConfirmer aliveConfirmer)

setPreferredDelimiter

public void setPreferredDelimiter(char[] preferredDelimiter)

chooseSuitableCharsetFrom

public java.lang.String chooseSuitableCharsetFrom(java.lang.String filePath,
                                                  java.lang.String[] charsetOptions)

Returns a suitable charset name to read the file, trying in the order of charsetOptions. Performance hint: this method will read the entire file to ensure there is no exception at all

Parameters:

filePath - the path of the file to be checked

charsetOptions - the names of the charsets to be tested

Returns:

a suitable charset name to read the file

checkFile

public void checkFile(java.io.BufferedReader bure,
                      java.lang.String[] mandatoryColumnNames)
               throws CSVImport.NoDataFoundException

Throws:

CSVImport.NoDataFoundException

checkFile

public java.lang.String checkFile(java.lang.String filePath,
                                  java.lang.String[] mandatoryColumnNames)
                           throws CSVImport.NoDataFoundException

Throws:

CSVImport.NoDataFoundException

checkFile

public java.lang.String checkFile(java.lang.String filePath,
                                  java.lang.String[] mandatoryColumnNames,
                                  java.lang.String charsetName)
                           throws CSVImport.NoDataFoundException

Returns the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid.

Parameters:

filePath - the path of the file to be checked

mandatoryColumnNames - column names that are mandatory

charsetName - the charset name to open the file

Returns:

the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid

Throws:

CSVImport.NoDataFoundException

checkFileReturnCharset

public java.lang.String checkFileReturnCharset(java.lang.String filePath,
                                               java.lang.String[][] mandatoryColumnNameAlternatives,
                                               java.lang.String charsetName)
                                        throws CSVImport.NoDataFoundException

Returns the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid.

Parameters:

filePath - the path of the file to be checked

mandatoryColumnNameAlternatives - a list of alternatives of column names that are mandatory

charsetName - the charset name to open the file

Returns:

the valid charset name if the file may be read using the specified charset name or null if the specified charset name is not valid

Throws:

CSVImport.NoDataFoundException

checkFile

public void checkFile(java.io.BufferedReader bure,
                      java.lang.String[][] mandatoryColumnNameAlternatives)
               throws CSVImport.NoDataFoundException

Throws:

CSVImport.NoDataFoundException

checkFile

public java.lang.String checkFile(java.lang.String filePath,
                                  java.lang.String[][] mandatoryColumnNameAlternatives)
                           throws CSVImport.NoDataFoundException

Checks the file and returns the suitable charset name to read it.

Parameters:

filePath - the path of the file to be checked

mandatoryColumnNameAlternatives - a list of alternatives of column names that are mandatory

Returns:

encoding to use - null is standard

Throws:

CSVImport.NoDataFoundException - if no alternative is fitting the needed data structure

checkFile

protected boolean checkFile(java.lang.String filePath,
                            java.lang.String[][] mandatoryColumnNameAlternatives,
                            java.lang.String charsetName)
                     throws CSVImport.NoDataFoundException

Throws:

CSVImport.NoDataFoundException

guessDelimiter

protected char guessDelimiter(java.io.BufferedReader bure)

guessDelimiter

protected char guessDelimiter(java.lang.String firstLine)

getMessageWhatsMissing

public java.lang.String getMessageWhatsMissing()

Returns message what's explicitly missing in first row, which is easer to understand for user than complete message of NoDataFoundException.

Returns:

message what's explicitly missing

setStatusInformation

protected void setStatusInformation(java.lang.String info)

getImportAmount

public int getImportAmount()