eu.wiegandt.nicklas.simpleexcelimexporter

Class AbstractExcelImExporter

java.lang.Object

eu.wiegandt.nicklas.simpleexcelimexporter.AbstractExcelImExporter

Direct Known Subclasses:

ExcelExporter, ExcelImporter

public abstract class AbstractExcelImExporter
extends Object

The abstract base for the im- and exporter.

Author:

Nicklas Wiegandt (Nicklas2751)
Mail: nicklas@wiegandt.eu
Jabber: nicklas2751@elaon.de
Skype: Nicklas2751

Field Summary

Fields

Modifier and Type	Field and Description
protected static Collection<ExcelTableManager>	tableManagers

Constructor Summary

Constructors

Constructor and Description
AbstractExcelImExporter() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addDataSetsToProcess(int aDataSetsToProcess)
boolean	addObserver(ExcelImExportObserver aExcelImExportObserver) Adds an observer for the im- exporter.
protected void	addProcessedDataSets(int aProcessedDataSets)
static boolean	addTableManager(ExcelTableManager aTableManager) Adds a table manager to the list of supported table managers for the im- / exporter.
protected void	calculateProgress() Calculates the progress percentage.
protected void	finishDataSetProcess() Increases the number of processed data sets by one.
protected void	finishSubRun() Increases the number of finished sub runs by one.
static void	generateCleanMappingFile(Path aFilePath, String aTableName) A helper method to generate a mapping file for a table. The mapping format is: "column name": "field name".
static void	generateCleanMappingFile(String aFilePath, String aTableName) Deprecated. Use generateCleanMappingFile(Path, String) instead.
protected org.apache.commons.collections4.BidiMap<String,String>	loadMapping(Path aMappingFilePath) Loads the mapping from a mapping file.
protected org.apache.commons.collections4.BidiMap<String,String>	loadMapping(String aMappingFilePath) Deprecated. Use loadMapping(Path) instead.
protected void	postError(ExcelImExporterError aError) Posts an error for the observers.
protected void	postWarning(ExcelImExporterWarning aWarning) Posts an warning for the observers.
boolean	removeObserver(ExcelImExportObserver aExcelImExportObserver) Removes an observer.
static boolean	removeTableManager(ExcelTableManager aTableManager) Removes a table manager.
protected static Optional<ExcelTableManager>	searchTableManager(String aTableName) Searches for a table manager for a table with the given table name.
protected void	setSubRuns(int aSubRuns)
protected void	updateProgress() Updates the percentage for each observer.

Methods inherited from class java.lang.Object

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

Field Detail

tableManagers

protected static final Collection<ExcelTableManager> tableManagers

Constructor Detail

AbstractExcelImExporter

public AbstractExcelImExporter()

The default constructor. It checks if one or more table managers are set and initializes the statistics.

Method Detail

addTableManager

public static boolean addTableManager(ExcelTableManager aTableManager)

Adds a table manager to the list of supported table managers for the im- / exporter.

Parameters:

aTableManager - The table manager which should be added.

Returns:

true if adding was successful.

See Also:

Collection.add(Object)

generateCleanMappingFile

@Deprecated
public static void generateCleanMappingFile(String aFilePath,
                                                        String aTableName)
                                                 throws IOException

Deprecated. Use generateCleanMappingFile(Path, String) instead.

* A helper method to generate a mapping file for a table.
The mapping format is: "column name": "field name".

Parameters:

aFilePath - The path where the mapping file should be saved.

aTableName - The table name for which the file should be generated.

Throws:

IOException - if the file can't be written.

IllegalArgumentException - if no table with the given table name is available for im- or export.

generateCleanMappingFile

public static void generateCleanMappingFile(Path aFilePath,
                                            String aTableName)
                                     throws IOException

A helper method to generate a mapping file for a table.
The mapping format is: "column name": "field name".

Parameters:

aFilePath - The path where the mapping file should be saved.

aTableName - The table name for which the file should be generated.

Throws:

IOException - if the file can't be written.

IllegalArgumentException - if no table with the given table name is available for im- or export.

removeTableManager

public static boolean removeTableManager(ExcelTableManager aTableManager)

Removes a table manager.

Parameters:

aTableManager - The table manager which should be removed.

Returns:

true if the table manager was successful removed.

See Also:

Collection.remove(Object)

searchTableManager

protected static Optional<ExcelTableManager> searchTableManager(String aTableName)

Searches for a table manager for a table with the given table name.

Parameters:

aTableName - The table name for which a table manager should be searched.

Returns:

Returns a Optional with the search result.

addObserver

public boolean addObserver(ExcelImExportObserver aExcelImExportObserver)

Adds an observer for the im- exporter.

Parameters:

aExcelImExportObserver - The observer which should be added.

Returns:

true if the adding was successful.

See Also:

Collection.add(Object)

removeObserver

public boolean removeObserver(ExcelImExportObserver aExcelImExportObserver)

Removes an observer.

Parameters:

aExcelImExportObserver - The observer which should be removed.

Returns:

true if the removing was successful.

See Also:

Collection.remove(Object)

addDataSetsToProcess

protected void addDataSetsToProcess(int aDataSetsToProcess)

addProcessedDataSets

protected void addProcessedDataSets(int aProcessedDataSets)

calculateProgress

protected void calculateProgress()

Calculates the progress percentage. Uses the number of "sub runs" where each sub run is a table so the result is for the complete im-/export.

finishDataSetProcess

protected void finishDataSetProcess()

Increases the number of processed data sets by one.

finishSubRun

protected void finishSubRun()

Increases the number of finished sub runs by one.

loadMapping

@Deprecated
protected org.apache.commons.collections4.BidiMap<String,String> loadMapping(String aMappingFilePath)
                                                                                  throws ExcelImExporterException

Deprecated. Use loadMapping(Path) instead.

Loads the mapping from a mapping file.

Parameters:

aMappingFilePath - The path to the mapping file.

Returns:

The mapping.

Throws:

ExcelImExporterException - will be thrown if the mapping file is invalid.

loadMapping

protected org.apache.commons.collections4.BidiMap<String,String> loadMapping(Path aMappingFilePath)
                                                                      throws ExcelImExporterException

Loads the mapping from a mapping file.

Parameters:

aMappingFilePath - The path to the mapping file.

Returns:

The mapping.

Throws:

ExcelImExporterException - will be thrown if the mapping file is invalid.

postError

protected void postError(ExcelImExporterError aError)

Posts an error for the observers.

Parameters:

aError - The error which should be posted.

postWarning

protected void postWarning(ExcelImExporterWarning aWarning)

Posts an warning for the observers.

Parameters:

aWarning - The warning which should be posted.

setSubRuns

protected void setSubRuns(int aSubRuns)

updateProgress

protected void updateProgress()

Updates the percentage for each observer.