nl.bstoi.poiparser.core.strategy.annotation

Class AnnotatedPoiFileParser<T>

java.lang.Object

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

nl.bstoi.poiparser.core.strategy.annotation.AnnotatedPoiFileParser<T>

public class AnnotatedPoiFileParser<T>
extends AbstractPoiFileParser<T>

Constructor Summary

Constructors

Constructor and Description
AnnotatedPoiFileParser() Default constructor
AnnotatedPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping) Use a different column field mapping and ignore the @Cell values in class.
AnnotatedPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping, java.util.Set<java.lang.Integer> requiredColumnNumbers) Use a different column field mapping and ignore the @Cell values in class.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	parseExcelMappingForClass(java.lang.Class clazz) Recursive read of super classes that have excel parser information
java.util.List<T>	readExcelFile(java.io.File excelFile, java.lang.String sheetName, java.lang.Class<T> clazz)
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.
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
java.util.List<T>	readExcelFile(java.io.InputStream inputStream, java.lang.String sheetName, java.lang.Class<T> clazz)
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
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
void	writeExcelFile(java.io.OutputStream outputStream, java.util.LinkedHashMap<java.lang.String,java.util.List<T>> excelDataMap, java.lang.Class<T> clazz)

Methods inherited from class nl.bstoi.poiparser.core.strategy.AbstractPoiFileParser

addColumnFieldNameMapping, addColumnFieldRegex, addReadIgnoreColumn, addRequiredField, addWriteIgnoreColumn, getColumnFieldNameMapping, getDefaultConverterFactory, getHeaderFieldNameTranslationMapping, getReadIgnoreColumns, getWriteIgnoreColumns, ignoreRow, isEmptyRow, isEmptyValue, isIgnoreEmptyRows, isIgnoreFirstRow, isRemoveWriteIgnoreColumns, readField, readRow, readSheet, readSheet, readSheet, remapColumnFieldMapForWriting, setHeaderFieldNameTranslationMapping, setIgnoreEmptyRows, setIgnoreFirstRow, setRemoveWriteIgnoreColumns, validateColumnFieldMapForWriting, writeCell, writeHeaderRow, writeRow, writeSheet, writeWorkbook

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedPoiFileParser

public AnnotatedPoiFileParser()

Default constructor

AnnotatedPoiFileParser

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

Use a different column field mapping and ignore the @Cell values in class.

Parameters:

columnFieldNameMapping -

AnnotatedPoiFileParser

public AnnotatedPoiFileParser(java.util.Map<java.lang.String,java.lang.Integer> columnFieldNameMapping,
                      java.util.Set<java.lang.Integer> requiredColumnNumbers)

Use a different column field mapping and ignore the @Cell values in class.

Parameters:

columnFieldNameMapping -

Method Detail

readExcelFile

public 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

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public 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

Description copied from class: AbstractPoiFileParser

Read a excel file from start row to end row

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public 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

Description copied from class: AbstractPoiFileParser

Read a excel file from start row to last row.

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public 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

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public 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

Description copied from class: AbstractPoiFileParser

Read a excel file inputstream start row to end row

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

readExcelFile

public 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

Description copied from class: AbstractPoiFileParser

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

Specified by:

readExcelFile in class AbstractPoiFileParser<T>

Returns:

Throws:

java.io.IOException

java.io.FileNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

RequiredFieldPoiParserException

ReadPoiParserException

writeExcelFile

public 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

Specified by:

writeExcelFile in class AbstractPoiFileParser<T>

Throws:

java.io.IOException

InitialWritePoiParserException

WritePoiParserException

parseExcelMappingForClass

protected void parseExcelMappingForClass(java.lang.Class clazz)

Recursive read of super classes that have excel parser information

Parameters:

clazz -

excelMapping -