org.nuxeo.ecm.platform.groups.audit.service.acl.excel

Class ExcelBuilderMultiSheet

java.lang.Object

org.nuxeo.ecm.platform.groups.audit.service.acl.excel.ExcelBuilder

org.nuxeo.ecm.platform.groups.audit.service.acl.excel.ExcelBuilderMultiSheet

All Implemented Interfaces:

IExcelBuilder

public class ExcelBuilderMultiSheet
extends ExcelBuilder

Override the default ExcelBuilder to write over several excel sheet once a cell column exceeds the maximum number of column for excel.

Author:

Martin Pernollet

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.platform.groups.audit.service.acl.excel.ExcelBuilder

ExcelBuilder.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	multiSheetMode

Fields inherited from class org.nuxeo.ecm.platform.groups.audit.service.acl.excel.ExcelBuilder

boldFont, CRASH_ON_CELL_OVERFLOW, create, currentSheetId, drawing, LAST_COLUMN, LAST_ROW, MAX_COLUMN, MAX_ROW, sheets, type, workbook

Constructor Summary

Constructors

Constructor and Description
ExcelBuilderMultiSheet()
ExcelBuilderMultiSheet(ExcelBuilder.Type type)
ExcelBuilderMultiSheet(ExcelBuilder.Type type, String firstSheet)

Method Summary

Modifier and Type	Method and Description
protected int	autoSelectSheet(int column) Compute the sheet/column required to access the given column.
protected org.apache.poi.ss.usermodel.Cell	getOrCreateCell(int i, int j)
int	getVirtualCellColumn(int realColumn) Return a column ID for the expected cell: returns 255 for realColumn=255 returns 0 for realColumn=256 ...
int	getVirtualCellSheet(int realColumn) Return a sheet ID for the expected cell: sheet 0 for cells [0;255] sheet 1 for cells [256;511] ...
boolean	isMultiSheetColumns()
void	setMultiSheetColumns(boolean multiSheetMode) If true, the builder is able to switch on next sheets to fill cells with column id > 255.
protected boolean	validateCellIndex(int row, int column, String content) Only invalidate cells having a too large row id.

Methods inherited from class org.nuxeo.ecm.platform.groups.audit.service.acl.excel.ExcelBuilder

addComment, buildComment, getAllSheets, getBoldFont, getColor, getColor, getCurrentSheet, getCurrentSheetId, getHSSFWorkbook, getOrCreateRow, getWorkbook, load, load, loadPicture, mergeRange, newCellStyle, newColoredCellStyle, newFont, newFont, newSheet, save, save, setCell, setCell, setColumnWidth, setColumnWidthAuto, setCurrentSheetId, setFreezePane, setFreezePane, setPicture, setRowHeight, setSplitPane, sheetInitialized

Methods inherited from class java.lang.Object

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

Field Detail

multiSheetMode

protected boolean multiSheetMode

Constructor Detail

ExcelBuilderMultiSheet

public ExcelBuilderMultiSheet()

ExcelBuilderMultiSheet

public ExcelBuilderMultiSheet(ExcelBuilder.Type type,
                              String firstSheet)

ExcelBuilderMultiSheet

public ExcelBuilderMultiSheet(ExcelBuilder.Type type)

Method Detail

isMultiSheetColumns

public boolean isMultiSheetColumns()

setMultiSheetColumns

public void setMultiSheetColumns(boolean multiSheetMode)

If true, the builder is able to switch on next sheets to fill cells with column id > 255.

getOrCreateCell

protected org.apache.poi.ss.usermodel.Cell getOrCreateCell(int i,
                                                           int j)

Overrides:

getOrCreateCell in class ExcelBuilder

validateCellIndex

protected boolean validateCellIndex(int row,
                                    int column,
                                    String content)

Only invalidate cells having a too large row id. Validate a cell index. If cell index is out of maximum number of rows/columns:

• throws an IllegalArgumentException if CRASH_ON_CELL_OVERFLOW is set to true.
• otherwise emit a log warning and return false to invalidate this cell.

Overrides:

validateCellIndex in class ExcelBuilder

getVirtualCellSheet

public int getVirtualCellSheet(int realColumn)

Return a sheet ID for the expected cell:

• sheet 0 for cells [0;255]
• sheet 1 for cells [256;511]
• ...

getVirtualCellColumn

public int getVirtualCellColumn(int realColumn)

Return a column ID for the expected cell:

• returns 255 for realColumn=255
• returns 0 for realColumn=256
• ...

autoSelectSheet

protected int autoSelectSheet(int column)

Compute the sheet/column required to access the given column. If expected sheet is not current, change it. If it does not exist, create it.

Returns:

an updated column index.