nl.bstoi.poiparser.core.strategy

Class AbstractPoiFileParser<T>

java.lang.Object

nl.bstoi.poiparser.core.strategy.AbstractPoiFileParser<T>

Direct Known Subclasses:

AnnotatedPoiFileParser

public abstract class AbstractPoiFileParser<T>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractPoiFileParser()
AbstractPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping)
AbstractPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping, java.util.Set<java.lang.Integer> requiredFields)

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumnFieldNameMapping(java.lang.String fieldName, java.lang.Integer columnNumber) Add a mapping for a column
void	addColumnFieldRegex(java.lang.String fieldName, java.lang.String regex) Validate if regex patter is correct and it to the validation rules
void	addReadIgnoreColumn(java.lang.Integer columnNumber) Add a column number for ignoring when reading.
void	addRequiredField(java.lang.Integer columnNumber) Add the column number for a required field
void	addWriteIgnoreColumn(java.lang.Integer columnNumber) Add a column number for ignoring when writing.
java.util.Map<java.lang.String,java.lang.Integer>	getColumnFieldNameMapping()
DefaultConverterFactory	getDefaultConverterFactory()
java.util.Map<java.lang.String,java.lang.String>	getHeaderFieldNameTranslationMapping()
java.util.Set<java.lang.Integer>	getReadIgnoreColumns()
java.util.Set<java.lang.Integer>	getWriteIgnoreColumns()
boolean	ignoreRow(org.apache.poi.ss.usermodel.Row row) If row is empty, the ignore empty row setting will determine the adding of the row.
boolean	isEmptyRow(org.apache.poi.ss.usermodel.Row row) Check whether a row is empty based on the column values
boolean	isEmptyValue(org.apache.poi.ss.usermodel.Cell cell) Check if the hssfCell is empty or blank
boolean	isIgnoreEmptyRows()
boolean	isIgnoreFirstRow()
boolean	isRemoveWriteIgnoreColumns() If columns that are ignored must be deleted from the sheet when writing.
abstract java.util.List<T>	readExcelFile(java.io.File excelFile, java.lang.String sheetName, java.lang.Class<T> clazz)
abstract java.util.List<T>	readExcelFile(java.io.File excelFile, java.lang.String sheetName, java.lang.Class<T> clazz, int startRow) Read a excel file from start row to last row.
abstract java.util.List<T>	readExcelFile(java.io.File excelFile, java.lang.String sheetName, java.lang.Class<T> clazz, int startRow, int endRow) Read a excel file from start row to end row
abstract java.util.List<T>	readExcelFile(java.io.InputStream inputStream, java.lang.String sheetName, java.lang.Class<T> clazz)
abstract java.util.List<T>	readExcelFile(java.io.InputStream inputStream, java.lang.String sheetName, java.lang.Class<T> clazz, int startRow) Read a excel file input stream from given start row until last row
abstract java.util.List<T>	readExcelFile(java.io.InputStream inputStream, java.lang.String sheetName, java.lang.Class<T> clazz, int startRow, int endRow) Read a excel file inputstream start row to end row
protected void	readField(java.lang.String sheetName, org.apache.poi.ss.usermodel.Row row, T rowDimension, java.lang.String fieldName) Read a specific field and fill it with the value in the excel
protected T	readRow(java.lang.String sheetName, org.apache.poi.ss.usermodel.Row row, T rowDimension) Read a excel row and convert the selected field into a row dimension
protected java.util.List<T>	readSheet(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Class<T> clazz) Read Excel sheet.
protected java.util.List<T>	readSheet(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Class<T> clazz, int startRow)
protected java.util.List<T>	readSheet(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Class<T> clazz, int startRow, int endRow)
protected void	remapColumnFieldMapForWriting() Re-map the columns when empty columns are ignored
void	setHeaderFieldNameTranslationMapping(java.util.Map<java.lang.String,java.lang.String> headerFieldNameTranslationMapping)
void	setIgnoreEmptyRows(boolean ignoreEmptyRows)
void	setIgnoreFirstRow(boolean ignoreFirstRow)
void	setRemoveWriteIgnoreColumns(boolean removeWriteIgnoreColumns) Set if the parser deletes the columns when writing a sheet.
protected void	validateColumnFieldMapForWriting() Validate if columns are used more than once.
protected void	writeCell(org.apache.poi.ss.usermodel.Row row, T dimension, java.lang.String fieldName)
abstract void	writeExcelFile(java.io.OutputStream outputStream, java.util.LinkedHashMap<java.lang.String,java.util.List<T>> excelDataMap, java.lang.Class<T> clazz)
protected void	writeHeaderRow(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Integer rowNumber)
protected void	writeRow(org.apache.poi.ss.usermodel.Sheet sheet, T dimension, java.lang.Integer rowNumber)
protected void	writeSheet(org.apache.poi.ss.usermodel.Workbook workbook, java.lang.String sheetName, java.util.List<T> dimensionList)
protected org.apache.poi.ss.usermodel.Workbook	writeWorkbook(java.util.LinkedHashMap<java.lang.String,java.util.List<T>> excelDataMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPoiFileParser

public AbstractPoiFileParser()

AbstractPoiFileParser

public AbstractPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping)

AbstractPoiFileParser

public AbstractPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping,
                     java.util.Set<java.lang.Integer> requiredFields)

Method Detail

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.File excelFile,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.InputStream inputStream,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.File excelFile,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz,
                              int startRow,
                              int endRow)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Read a excel file from start row to end row

Parameters:

excelFile -

sheetName -

clazz -

startRow -

endRow -

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.File excelFile,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz,
                              int startRow)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Read a excel file from start row to last row.

Parameters:

excelFile -

sheetName -

clazz -

startRow -

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.InputStream inputStream,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz,
                              int startRow,
                              int endRow)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Read a excel file inputstream start row to end row

Parameters:

inputStream -

sheetName -

clazz -

startRow -

endRow -

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public abstract java.util.List<T> readExcelFile(java.io.InputStream inputStream,
                              java.lang.String sheetName,
                              java.lang.Class<T> clazz,
                              int startRow)
                                         throws java.io.IOException,
                                                java.io.FileNotFoundException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                RequiredFieldPoiParserException,
                                                ReadPoiParserException

Read a excel file input stream from given start row until last row

Parameters:

inputStream -

sheetName -

clazz -

startRow -

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

writeExcelFile

public abstract void writeExcelFile(java.io.OutputStream outputStream,
                  java.util.LinkedHashMap<java.lang.String,java.util.List<T>> excelDataMap,
                  java.lang.Class<T> clazz)
                             throws java.io.IOException,
                                    InitialWritePoiParserException,
                                    WritePoiParserException

Throws:

java.io.IOException

InitialWritePoiParserException

WritePoiParserException

readSheet

protected java.util.List<T> readSheet(org.apache.poi.ss.usermodel.Sheet sheet,
                          java.lang.Class<T> clazz)
                               throws java.lang.InstantiationException,
                                      java.lang.IllegalAccessException,
                                      RequiredFieldPoiParserException,
                                      ReadPoiParserException

Read Excel sheet.

Parameters:

sheet -

clazz -

Returns:

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readSheet

protected java.util.List<T> readSheet(org.apache.poi.ss.usermodel.Sheet sheet,
                          java.lang.Class<T> clazz,
                          int startRow)
                               throws java.lang.InstantiationException,
                                      java.lang.IllegalAccessException,
                                      RequiredFieldPoiParserException,
                                      ReadPoiParserException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readSheet

protected java.util.List<T> readSheet(org.apache.poi.ss.usermodel.Sheet sheet,
                          java.lang.Class<T> clazz,
                          int startRow,
                          int endRow)
                               throws java.lang.InstantiationException,
                                      java.lang.IllegalAccessException,
                                      RequiredFieldPoiParserException,
                                      ReadPoiParserException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readRow

protected T readRow(java.lang.String sheetName,
        org.apache.poi.ss.usermodel.Row row,
        T rowDimension)
             throws RequiredFieldPoiParserException,
                    ReadPoiParserException

Read a excel row and convert the selected field into a row dimension

Parameters:

row -

rowDimension -

Returns:

Throws:

RequiredFieldPoiParserException

ReadPoiParserException

readField

protected void readField(java.lang.String sheetName,
             org.apache.poi.ss.usermodel.Row row,
             T rowDimension,
             java.lang.String fieldName)
                  throws RequiredFieldPoiParserException,
                         ReadPoiParserException

Read a specific field and fill it with the value in the excel

Parameters:

row - Excel row

rowDimension - Abstract representation of a row

fieldName - Name of a field in the class

Throws:

RequiredFieldPoiParserException

ReadPoiParserException

writeWorkbook

protected org.apache.poi.ss.usermodel.Workbook writeWorkbook(java.util.LinkedHashMap<java.lang.String,java.util.List<T>> excelDataMap)
                                                      throws InitialWritePoiParserException,
                                                             WritePoiParserException

Throws:

InitialWritePoiParserException

WritePoiParserException

writeSheet

protected void writeSheet(org.apache.poi.ss.usermodel.Workbook workbook,
              java.lang.String sheetName,
              java.util.List<T> dimensionList)
                   throws WritePoiParserException

Throws:

WritePoiParserException

writeRow

protected void writeRow(org.apache.poi.ss.usermodel.Sheet sheet,
            T dimension,
            java.lang.Integer rowNumber)
                 throws WritePoiParserException

Throws:

WritePoiParserException

writeHeaderRow

protected void writeHeaderRow(org.apache.poi.ss.usermodel.Sheet sheet,
                  java.lang.Integer rowNumber)

writeCell

protected void writeCell(org.apache.poi.ss.usermodel.Row row,
             T dimension,
             java.lang.String fieldName)
                  throws WritePoiParserException

Throws:

WritePoiParserException

ignoreRow

public boolean ignoreRow(org.apache.poi.ss.usermodel.Row row)

If row is empty, the ignore empty row setting will determine the adding of the row.

Parameters:

hssfRow -

Returns:

isEmptyRow

public boolean isEmptyRow(org.apache.poi.ss.usermodel.Row row)

Check whether a row is empty based on the column values

Parameters:

hssfRow -

Returns:

isEmptyValue

public boolean isEmptyValue(org.apache.poi.ss.usermodel.Cell cell)

Check if the hssfCell is empty or blank

Parameters:

hssfCell -

Returns:

validateColumnFieldMapForWriting

protected void validateColumnFieldMapForWriting()
                                         throws InitialWritePoiParserException

Validate if columns are used more than once.

Throws:

InitialWritePoiParserException

remapColumnFieldMapForWriting

protected void remapColumnFieldMapForWriting()
                                      throws InitialWritePoiParserException

Re-map the columns when empty columns are ignored

Throws:

InitialWritePoiParserException

isIgnoreEmptyRows

public boolean isIgnoreEmptyRows()

setIgnoreEmptyRows

public void setIgnoreEmptyRows(boolean ignoreEmptyRows)

setIgnoreFirstRow

public void setIgnoreFirstRow(boolean ignoreFirstRow)

isIgnoreFirstRow

public boolean isIgnoreFirstRow()

isRemoveWriteIgnoreColumns

public boolean isRemoveWriteIgnoreColumns()

If columns that are ignored must be deleted from the sheet when writing.

Returns:

setRemoveWriteIgnoreColumns

public void setRemoveWriteIgnoreColumns(boolean removeWriteIgnoreColumns)

Set if the parser deletes the columns when writing a sheet.

Parameters:

removeWriteIgnoreColumns -

getColumnFieldNameMapping

public java.util.Map<java.lang.String,java.lang.Integer> getColumnFieldNameMapping()

getHeaderFieldNameTranslationMapping

public java.util.Map<java.lang.String,java.lang.String> getHeaderFieldNameTranslationMapping()

setHeaderFieldNameTranslationMapping

public void setHeaderFieldNameTranslationMapping(java.util.Map<java.lang.String,java.lang.String> headerFieldNameTranslationMapping)

addColumnFieldNameMapping

public void addColumnFieldNameMapping(java.lang.String fieldName,
                             java.lang.Integer columnNumber)

Add a mapping for a column

Parameters:

fieldName -

columnNumber -

addRequiredField

public void addRequiredField(java.lang.Integer columnNumber)

Add the column number for a required field

Parameters:

columnNumber -

addColumnFieldRegex

public void addColumnFieldRegex(java.lang.String fieldName,
                       java.lang.String regex)

Validate if regex patter is correct and it to the validation rules

Parameters:

fieldName -

regex -

addReadIgnoreColumn

public void addReadIgnoreColumn(java.lang.Integer columnNumber)

Add a column number for ignoring when reading.

Parameters:

columnNumber -

addWriteIgnoreColumn

public void addWriteIgnoreColumn(java.lang.Integer columnNumber)

Add a column number for ignoring when writing.

Parameters:

columnNumber -

getWriteIgnoreColumns

public java.util.Set<java.lang.Integer> getWriteIgnoreColumns()

getReadIgnoreColumns

public java.util.Set<java.lang.Integer> getReadIgnoreColumns()

getDefaultConverterFactory

public DefaultConverterFactory getDefaultConverterFactory()