com.myjeeva.poi

Class ExcelWorkSheetHandler<T>

java.lang.Object

com.myjeeva.poi.ExcelWorkSheetHandler<T>

All Implemented Interfaces:

XSSFSheetXMLHandler.SheetContentsHandler

public class ExcelWorkSheetHandler<T>
extends java.lang.Object
implements XSSFSheetXMLHandler.SheetContentsHandler

Generic Excel WorkSheet handler

Since:

v1.0

Author:

Jeevanandam M.

Constructor Summary

Constructors

Constructor and Description
ExcelWorkSheetHandler(java.lang.Class<T> type, java.util.Map<java.lang.String,java.lang.String> cellMapping) Constructor For Example: Reading rows (zero based) starting from Zero ExcelWorkSheetHandler<PersonVO> workSheetHandler = new ExcelWorkSheetHandler<PersonVO>(PersonVO.class, cellMapping);
ExcelWorkSheetHandler(java.lang.Class<T> type, java.util.Map<java.lang.String,java.lang.String> cellMapping, int skipRows) Constructor For Example: Reading rows (zero based) starting from Row 11 ExcelWorkSheetHandler<PersonVO> workSheetHandler = new ExcelWorkSheetHandler<PersonVO>(PersonVO.class, cellMapping, 10);

Method Summary

Methods

Modifier and Type	Method and Description
void	cell(java.lang.String cellReference, java.lang.String formattedValue)
void	endRow()
java.util.List<T>	getValueList() Returns Value List (List<T>) read from Excel Workbook, Row represents one Object in a List.
void	headerFooter(java.lang.String text, boolean isHeader, java.lang.String tagName) Currently not considered for implementation
boolean	isVerifiyHeader() Returns Excel Header check state, default it is enabled
void	setVerifiyHeader(boolean verifiyHeader) To set the Excel Header check state, default it is enabled
void	startRow(int rowNum)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelWorkSheetHandler

public ExcelWorkSheetHandler(java.lang.Class<T> type,
                     java.util.Map<java.lang.String,java.lang.String> cellMapping)

Constructor

For Example: Reading rows (zero based) starting from Zero
ExcelWorkSheetHandler<PersonVO> workSheetHandler = new ExcelWorkSheetHandler<PersonVO>(PersonVO.class, cellMapping);

Parameters:

type - a Class object

cellMapping - a Map object

ExcelWorkSheetHandler

public ExcelWorkSheetHandler(java.lang.Class<T> type,
                     java.util.Map<java.lang.String,java.lang.String> cellMapping,
                     int skipRows)

Constructor

For Example: Reading rows (zero based) starting from Row 11
ExcelWorkSheetHandler<PersonVO> workSheetHandler = new ExcelWorkSheetHandler<PersonVO>(PersonVO.class, cellMapping, 10);

Parameters:

type - a Class object

cellMapping - a Map object

skipRows - a int object - Number rows to skip (zero based). default is 0

Method Detail

getValueList

public java.util.List<T> getValueList()

Returns Value List (List<T>) read from Excel Workbook, Row represents one Object in a List.

For Example:
List<PersonVO> persons = workSheetHandler.getValueList();

Returns:

List<T>

isVerifiyHeader

public boolean isVerifiyHeader()

Returns Excel Header check state, default it is enabled

Returns:

boolean

setVerifiyHeader

public void setVerifiyHeader(boolean verifiyHeader)

To set the Excel Header check state, default it is enabled

Parameters:

verifiyHeader - a boolean

startRow

public void startRow(int rowNum)

Specified by:

startRow in interface XSSFSheetXMLHandler.SheetContentsHandler

See Also:

XSSFSheetXMLHandler.SheetContentsHandler.startRow(int)

cell

public void cell(java.lang.String cellReference,
        java.lang.String formattedValue)

Specified by:

cell in interface XSSFSheetXMLHandler.SheetContentsHandler

See Also:

XSSFSheetXMLHandler.SheetContentsHandler.cell(java.lang.String, java.lang.String)

endRow

public void endRow()

Specified by:

endRow in interface XSSFSheetXMLHandler.SheetContentsHandler

See Also:

XSSFSheetXMLHandler.SheetContentsHandler.endRow()

headerFooter

public void headerFooter(java.lang.String text,
                boolean isHeader,
                java.lang.String tagName)

Currently not considered for implementation

Specified by:

headerFooter in interface XSSFSheetXMLHandler.SheetContentsHandler

See Also:

XSSFSheetXMLHandler.SheetContentsHandler.headerFooter(java.lang.String, boolean, java.lang.String)