com.neurosys.bi.reporting.writers

Class CSVTabularDataWriter

java.lang.Object

com.neurosys.bi.reporting.writers.CSVTabularDataWriter

All Implemented Interfaces:

ReportWriter, Writer

public class CSVTabularDataWriter
extends Object
implements ReportWriter

Generate an CSV Report using a base Report generator(s) and writes it to an OutputStream as a Text CSV File

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Reporter<Object[]>>	baseReporters Each Reporter will create a new Section
protected org.apache.poi.ss.usermodel.Workbook	workbook

Constructor Summary

Constructors

Constructor and Description
CSVTabularDataWriter()

Method Summary

Modifier and Type	Method and Description
List<Reporter<Object[]>>	getBaseReporters() Each Reporter will create a new Sheet
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
void	init() Initialize the Export Writer
void	setBaseReporters(List<Reporter<Object[]>> baseReporters) Each Reporter will create a new Sheet
org.apache.poi.ss.usermodel.Workbook	writeDataToFile(Object[] params, PageInfo pageInfo) Generate the file from the data
void	writeDataToStream(OutputStream outputStream, Object[] params, PageInfo pageInfo) Generate the Excel and write it onto the OutputStream

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 Section

workbook

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

Constructor Detail

CSVTabularDataWriter

public CSVTabularDataWriter()

Method Detail

init

@PostConstruct
public void init()

Description copied from interface: ReportWriter

Initialize the Export Writer

Specified by:

init in interface ReportWriter

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 Report

index - as int

pageInfo - as PageInfo

Returns:

PageInfo

writeDataToFile

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

Generate the file 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