com.neurosys.bi.reporting.writers

Class ExcelTabularDataWriter

java.lang.Object

com.neurosys.bi.reporting.writers.ExcelTabularDataWriter

All Implemented Interfaces:

ReportWriter, Writer

Direct Known Subclasses:

DefaultStyledExcelTabularDataWriter

public class ExcelTabularDataWriter
extends Object
implements ReportWriter

Generate an Excel Report using a base Report generator(s) and writes it to an OutputStream as an HSSFWorkbook (Excel)
The generator must guarantee an output of Object[] / Column wise Data to be consumed by Excels tabular format.

THIS BEAN SHOULD NOT BE A SINGLETON

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Reporter<Object[]>>	baseReporters Each Reporter will create a new Sheet
protected org.apache.poi.ss.usermodel.CellStyle	dateStyle
protected Float	fixedHeightPts Optional height in Excel points.
protected org.apache.poi.ss.usermodel.Workbook	workbook
protected org.apache.poi.ss.usermodel.CellStyle	wrapStyle

Constructor Summary

Constructors

Constructor and Description
ExcelTabularDataWriter()

Method Summary

Modifier and Type	Method and Description
protected org.apache.poi.ss.usermodel.Sheet	createSheet(int index) Create a Sheet for index (starting @ 0) with Headers pre-filled.
protected boolean	displayColumn(int colIndex) Ability to remove / hide column.
List<Reporter<Object[]>>	getBaseReporters() Each Reporter will create a new Sheet
protected org.apache.poi.ss.usermodel.CellStyle	getCellStyle(int sheetIndex, int rowIndex, int colIndex, org.apache.poi.ss.usermodel.Cell cell)
String	getDateFormat() Date format for Date Cells
Float	getFixedHeightPts() Optional height in Excel points.
protected PageInfo	getPageInfoForReport(Reporter<Object[]> report, int index, PageInfo pageInfo) If the the data is is only a page then we should override and return the appropriate PageInfo
protected Object[]	getParamsForReport(Reporter<Object[]> report, int index, Object[] params) If there are conditions/parameters for the report; then supply them in accordance to what is required by the Data generating Reporters
protected org.apache.poi.ss.usermodel.CellStyle	getRowStyle(int sheetIndex, int rowIndex, org.apache.poi.ss.usermodel.Row row)
protected org.apache.poi.ss.usermodel.Sheet	getSheet(int index)
int	getStartCol() Optional fields that allow the writing from an index other than 0
int	getStartRow() Optional fields that allow the writing from an index other than 0
void	init() Initialize the Export Writer
protected org.apache.poi.ss.usermodel.CellStyle	mergeCellStyles(org.apache.poi.ss.usermodel.CellStyle rowStyle, org.apache.poi.ss.usermodel.CellStyle cellStyle) CellStyle replaces another CellStyle.
void	setBaseReporters(List<Reporter<Object[]>> baseReporters) Each Reporter will create a new Sheet
void	setDateFormat(String dateFormat) Date format for Date Cells
void	setFixedHeightPts(Float fixedHeightPts) Optional height in Excel points.
void	setStartCol(int startCol) Optional fields that allow the writing from an index other than 0
void	setStartRow(int startRow) Optional fields that allow the writing from an index other than 0
protected void	setValue(org.apache.poi.ss.usermodel.Cell cell, int ColIndex, Object value) Handle different data types and set the appropriate type on the given value in the Cell
void	writeDataToStream(OutputStream outputStream, Object[] params, PageInfo pageInfo) Generate the Excel and write it onto the OutputStream
org.apache.poi.ss.usermodel.Workbook	writeDataToWorkBook(Object[] params, PageInfo pageInfo) Generate the Excel Workbook from the data

Methods inherited from class java.lang.Object

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

Field Detail

baseReporters

protected List<Reporter<Object[]>> baseReporters

Each Reporter will create a new Sheet

fixedHeightPts

protected Float fixedHeightPts

Optional height in Excel points. If specified all Data rows will be set to standard fixed height

workbook

protected transient org.apache.poi.ss.usermodel.Workbook workbook

dateStyle

protected transient org.apache.poi.ss.usermodel.CellStyle dateStyle

wrapStyle

protected transient org.apache.poi.ss.usermodel.CellStyle wrapStyle

Constructor Detail

ExcelTabularDataWriter

public ExcelTabularDataWriter()

Method Detail

init

@PostConstruct
public void init()

Description copied from interface: ReportWriter

Initialize the Export Writer

Specified by:

init in interface ReportWriter

createSheet

protected org.apache.poi.ss.usermodel.Sheet createSheet(int index)

Create a Sheet for index (starting @ 0) with Headers pre-filled.
One can customize this to style, name sheets

Parameters:

index -

Returns:

displayColumn

protected boolean displayColumn(int colIndex)

Ability to remove / hide column. If true will show the column else will not reder the column or any data in it.

Parameters:

colIndex - as int (starts from 0)

getSheet

protected org.apache.poi.ss.usermodel.Sheet getSheet(int index)

getParamsForReport

protected Object[] getParamsForReport(Reporter<Object[]> report,
                                      int index,
                                      Object[] params)

If there are conditions/parameters for the report; then supply them in accordance to what is required by the Data generating Reporters

Parameters:

report - as Reporter

index - as int

paramsas - Object[]

Returns:

Object[]

getPageInfoForReport

protected PageInfo getPageInfoForReport(Reporter<Object[]> report,
                                        int index,
                                        PageInfo pageInfo)

If the the data is is only a page then we should override and return the appropriate PageInfo

Parameters:

report - as Reporter

index - as int

pageInfo - as PageInfo

Returns:

PageInfo

setValue

protected void setValue(org.apache.poi.ss.usermodel.Cell cell,
                        int ColIndex,
                        Object value)

Handle different data types and set the appropriate type on the given value in the Cell

Parameters:

cell - as Cell

colIndex - as the column number (starting from 0)

value - as Object

getRowStyle

protected org.apache.poi.ss.usermodel.CellStyle getRowStyle(int sheetIndex,
                                                            int rowIndex,
                                                            org.apache.poi.ss.usermodel.Row row)

getCellStyle

protected org.apache.poi.ss.usermodel.CellStyle getCellStyle(int sheetIndex,
                                                             int rowIndex,
                                                             int colIndex,
                                                             org.apache.poi.ss.usermodel.Cell cell)

mergeCellStyles

protected org.apache.poi.ss.usermodel.CellStyle mergeCellStyles(org.apache.poi.ss.usermodel.CellStyle rowStyle,
                                                                org.apache.poi.ss.usermodel.CellStyle cellStyle)
                                                         throws Exception

CellStyle replaces another CellStyle. Hence if there is a row style and a cell specific style they will overwrite one another. In particular the Cell style will overwrite. CellStyle properties are musch we may want to mix/merge instead of overwrite.

Parameters:

rowStyle - as CellStyle

cellStyle - as CellStyle

Returns:

Throws:

Exception

writeDataToWorkBook

public org.apache.poi.ss.usermodel.Workbook writeDataToWorkBook(Object[] params,
                                                                PageInfo pageInfo)
                                                         throws Exception

Generate the Excel Workbook from the data

Parameters:

params - as Object[] as any parameters to pass to the Reporter @nullable true

pageInfo - as PageInfo as any pagination details to pass @nullable true

Throws:

Exception

writeDataToStream

public void writeDataToStream(OutputStream outputStream,
                              Object[] params,
                              PageInfo pageInfo)
                       throws Exception

Generate the Excel and write it onto the OutputStream

Specified by:

writeDataToStream in interface ReportWriter

Parameters:

outputStream - as OutputStream

params - as Object[] as any parameters to pass to the Reporter @nullable true

pageInfo - as PageInfo as any pagination details to pass @nullable true

Throws:

Exception

getBaseReporters

public List<Reporter<Object[]>> getBaseReporters()

Each Reporter will create a new Sheet

Specified by:

getBaseReporters in interface ReportWriter

setBaseReporters

public void setBaseReporters(List<Reporter<Object[]>> baseReporters)

Each Reporter will create a new Sheet

Specified by:

setBaseReporters in interface ReportWriter

getFixedHeightPts

public Float getFixedHeightPts()

Optional height in Excel points. If specified all Data rows will be set to standard fixed height

setFixedHeightPts

public void setFixedHeightPts(Float fixedHeightPts)

Optional height in Excel points. If specified all Data rows will be set to standard fixed height

getDateFormat

public String getDateFormat()

Date format for Date Cells

Default value:

d/m/yyyy h:mm:ss

setDateFormat

public void setDateFormat(String dateFormat)

Date format for Date Cells

Default value:

d/m/yyyy h:mm:ss

getStartRow

public int getStartRow()

Optional fields that allow the writing from an index other than 0

Default value:

0

setStartRow

public void setStartRow(int startRow)

Optional fields that allow the writing from an index other than 0

Default value:

0

getStartCol

public int getStartCol()

Optional fields that allow the writing from an index other than 0

Default value:

0

setStartCol

public void setStartCol(int startCol)

Optional fields that allow the writing from an index other than 0

Default value:

0