Package com.github.javaxcel.out

Class ModelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

java.lang.Object

com.github.javaxcel.out.AbstractExcelWriter<W,T>

com.github.javaxcel.out.ModelWriter<W,T>

Type Parameters:

W - excel workbook

T - type of model

All Implemented Interfaces:

ExcelWriter<W,T>

public class ModelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>
extends AbstractExcelWriter<W,T>

Excel writer

Field Summary

Fields inherited from class com.github.javaxcel.out.AbstractExcelWriter

bodyStyles, filtered, headerNames, headerStyles, rotated, sheetName, willAutoResize, willHideColumns, willHideRows, workbook

Constructor Summary

Constructors

Constructor	Description
ModelWriter(W workbook, Class<T> type)

Method Summary

Modifier and Type	Method	Description
ModelWriter<W,T>	autoResizeColumns()
protected void	beforeWrite(OutputStream out, List<T> list)
ModelWriter<W,T>	bodyStyle(com.github.javaxcel.styler.ExcelStyleConfig config)	Sets style to body.
ModelWriter<W,T>	bodyStyles(com.github.javaxcel.styler.ExcelStyleConfig... configs)	Sets styles to body.
ModelWriter<W,T>	defaultValue(String defaultValue)	Sets default value when value to be written is null or empty.
ModelWriter<W,T>	enumDropdown()	Enables to create dropdowns for columns of enum.
ModelWriter<W,T>	filter()	Filters all columns.
protected int	getNumOfColumns()	Returns the number of columns.
ModelWriter<W,T>	headerNames(List<String> headerNames)	Sets header names.
ModelWriter<W,T>	headerStyle(com.github.javaxcel.styler.ExcelStyleConfig config)	Sets style to header.
ModelWriter<W,T>	headerStyles(com.github.javaxcel.styler.ExcelStyleConfig... configs)	Sets styles to header.
ModelWriter<W,T>	hideExtraColumns()
ModelWriter<W,T>	hideExtraRows()
protected void	ifHeaderNamesAreEmpty(List<String> headerNames)	Handles header names, if they are empty.
ModelWriter<W,T>	sheetName(String sheetName)	Sets sheet name.
ModelWriter<W,T>	unrotate()	Disables to rotate sheet.
protected void	writeToSheet(org.apache.poi.ss.usermodel.Sheet sheet, List<T> list)	Writes list of models to the sheet.

Methods inherited from class com.github.javaxcel.out.AbstractExcelWriter

afterWrite, write

Methods inherited from class java.lang.Object

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

Constructor Details

ModelWriter

public ModelWriter(W workbook, Class<T> type)

Parameters:

workbook - excel workbook

type - type of model

See Also:

ExcelWriterFactory.create(Workbook, Class)

Method Details

defaultValue

public ModelWriter<W,T> defaultValue(String defaultValue)

Sets default value when value to be written is null or empty.

Specified by:

defaultValue in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

defaultValue in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

defaultValue - replacement of the value when it is null or empty string.

Returns:

ModelWriter

sheetName

public ModelWriter<W,T> sheetName(String sheetName)

Sets sheet name.

Prefix for each sheet name. For example, if you set 'SHEET' to this, the names you can see are SHEET0, SHEET1, SHEET2, ...

If you invoke AbstractExcelWriter.unrotate(), the sheet name has no suffix. You can see the sheet name like this SHEET

Specified by:

sheetName in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

sheetName in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

sheetName - sheet name

Returns:

ModelWriter

See Also:

AbstractExcelWriter.unrotate(), WorkbookUtil.validateSheetName(String)

headerNames

public ModelWriter<W,T> headerNames(List<String> headerNames)

Sets header names.

For example, the following list will be exported.

 [
     {
         "serialNumber": 10000,
         "name": "Choco cereal",
         "apiId": "2a60-4973-aec0-685e",
         "width": null,
         "depth": 0.0,
         "height": 20.5,
         "weight": 580.5
     },
     {
         "serialNumber": 10001,
         "name": "Oatmeal cereal",
         "apiId": "f15d-384d-0a4b-97ec",
         "width": 10.2,
         "depth": 4.0,
         "height": 6.0,
         "weight": 575.0
     }
 ]
 

To change the header names, place the names you want them changed to in the order like this.

     List<String> names = Arrays.asList(
             "SERIAL_NUMBER", "NAME", "API_ID", "WIDTH" "DEPTH", "HEIGHT", "WEIGHT");

     ExcelWriterFactory.create(new SXSSFWorkbook(), Product.class)
             .headerNames(names)
             .write(new FileOutputStream(file), list);
 

Then the header names will be changed you want.

 +---------------+----------------+---------------------+-------+-------+--------+--------+
 | SERIAL_NUMBER | NAME           | API_ID              | WIDTH | DEPTH | HEIGHT | WEIGHT |
 +---------------+----------------+---------------------+-------+-------+--------+--------+
 | 10000         | Choco cereal   | 2a60-4973-aec0-685e |       | 0.0   | 20.5   | 580.5  |
 +---------------+----------------+---------------------+-------+-------+--------+--------+
 | 10001         | Oatmeal cereal | f15d-384d-0a4b-97ec | 10.2  | 4.0   | 6.0    | 575.0  |
 +---------------+----------------+---------------------+-------+-------+--------+--------+
 

Specified by:

headerNames in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

headerNames in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

headerNames - header names

Returns:

ModelWriter

See Also:

AbstractExcelWriter.createHeader(Sheet)

unrotate

public ModelWriter<W,T> unrotate()

Disables to rotate sheet.

If this is invoked, excel file has only one sheet.

Specified by:

unrotate in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

unrotate in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

ModelWriter

filter

public ModelWriter<W,T> filter()

Filters all columns.

Specified by:

filter in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

filter in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

ModelWriter

enumDropdown

public ModelWriter<W,T> enumDropdown()

Enables to create dropdowns for columns of enum.

If this is invoked, excel file has only one sheet.

Returns:

ModelWriter

See Also:

ExcelModel.enumDropdown(), ExcelColumn.enumDropdown()

headerStyle

public ModelWriter<W,T> headerStyle(com.github.javaxcel.styler.ExcelStyleConfig config)

Sets style to header.

Specified by:

headerStyle in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

headerStyle in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

config - style config

Returns:

ModelWriter

headerStyles

public ModelWriter<W,T> headerStyles(com.github.javaxcel.styler.ExcelStyleConfig... configs)

Sets styles to header.

Specified by:

headerStyles in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

headerStyles in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

configs - style configs

Returns:

ModelWriter

bodyStyle

public ModelWriter<W,T> bodyStyle(com.github.javaxcel.styler.ExcelStyleConfig config)

Sets style to body.

Specified by:

bodyStyle in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

bodyStyle in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

config - style config

Returns:

ModelWriter

bodyStyles

public ModelWriter<W,T> bodyStyles(com.github.javaxcel.styler.ExcelStyleConfig... configs)

Sets styles to body.

Specified by:

bodyStyles in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

bodyStyles in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

configs - style configs

Returns:

ModelWriter

autoResizeColumns

public ModelWriter<W,T> autoResizeColumns()

Specified by:

autoResizeColumns in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

autoResizeColumns in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

ModelWriter

See Also:

AbstractExcelWriter.write(OutputStream, List)

hideExtraRows

public ModelWriter<W,T> hideExtraRows()

This will automatically create rows up to the maximum number of rows and hide them. This action takes more time and makes file size bigger than it doesn't.

Specified by:

hideExtraRows in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

hideExtraRows in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

ModelWriter

See Also:

AbstractExcelWriter.write(OutputStream, List)

hideExtraColumns

public ModelWriter<W,T> hideExtraColumns()

Specified by:

hideExtraColumns in interface ExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Overrides:

hideExtraColumns in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

ModelWriter

See Also:

AbstractExcelWriter.write(OutputStream, List)

beforeWrite

protected void beforeWrite(OutputStream out, List<T> list)

Overrides:

beforeWrite in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

See Also:

createDropdowns(Sheet)

ifHeaderNamesAreEmpty

protected void ifHeaderNamesAreEmpty(List<String> headerNames)

Handles header names, if they are empty.

You have to implement how to do, if the header names are empty. For examples, you can throw exception or set default header names. This process will be executed before ExcelWriter writes header.

If the header names are not set through headerNames(List), this method brings the values from ExcelColumn.name().

Specified by:

ifHeaderNamesAreEmpty in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

headerNames - header names

See Also:

FieldUtils.toHeaderNames(List)

writeToSheet

protected void writeToSheet(org.apache.poi.ss.usermodel.Sheet sheet, List<T> list)

Writes list of models to the sheet.

Specified by:

writeToSheet in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Parameters:

sheet - sheet

list - list of models

getNumOfColumns

protected int getNumOfColumns()

Returns the number of columns.

Specified by:

getNumOfColumns in class AbstractExcelWriter<W extends org.apache.poi.ss.usermodel.Workbook,T>

Returns:

the number of columns