org.jxls.transform.poi

Class PoiTransformer

java.lang.Object

org.jxls.transform.AbstractTransformer

org.jxls.transform.poi.PoiTransformer

All Implemented Interfaces:

Transformer

Direct Known Subclasses:

SelectSheetsForStreamingPoiTransformer

public class PoiTransformer
extends AbstractTransformer

POI implementation of Transformer interface

Since:

1/23/12

Author:

Leonid Vysochyn

Field Summary

Fields

Modifier and Type	Field and Description
static String	POI_CONTEXT_KEY

Fields inherited from class org.jxls.transform.AbstractTransformer

sheetMap

Constructor Summary

Constructors

Constructor and Description
PoiTransformer(org.apache.poi.ss.usermodel.Workbook workbook, boolean streaming)
PoiTransformer(org.apache.poi.ss.usermodel.Workbook workbook, boolean streaming, int rowAccessWindowSize, boolean compressTmpFiles, boolean useSharedStringsTable)

Method Summary

Modifier and Type	Method and Description
void	addImage(AreaRef areaRef, byte[] imageBytes, ImageType imageType)
void	adjustTableSize(CellRef ref, Size size)
void	clearCell(CellRef cellRef)
protected void	copyMergedRegions(CellData sourceCellData, CellRef destCell)
static Context	createInitialContext()
static PoiTransformer	createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook)
static PoiTransformer	createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook, int rowAccessWindowSize, boolean compressTmpFiles)
static PoiTransformer	createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook, int rowAccessWindowSize, boolean compressTmpFiles, boolean useSharedStringsTable)
static PoiTransformer	createTransformer(InputStream is)
static PoiTransformer	createTransformer(InputStream is, OutputStream os)
static PoiTransformer	createTransformer(org.apache.poi.ss.usermodel.Workbook workbook)
boolean	deleteSheet(String sheetName)
void	dispose()
protected void	findAndRemoveExistingCellRegion(CellRef cellRef)
org.apache.poi.ss.usermodel.CellStyle	getCellStyle(CellRef cellRef)
List<CellData>	getCommentedCells()
InputStream	getInputStream()
Integer	getLastCommentedColumn()
OutputStream	getOutputStream()
protected org.apache.poi.ss.usermodel.Row	getRowForClearCell(org.apache.poi.ss.usermodel.Sheet sheet, CellRef cellRef)
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
org.apache.poi.xssf.usermodel.XSSFWorkbook	getXSSFWorkbook()
protected boolean	isStreaming()
protected CellData	isTransformable(CellRef srcCellRef, CellRef targetCellRef)
void	mergeCells(CellRef cellRef, int rows, int cols)
protected void	removeCellComment(org.apache.poi.ss.usermodel.Sheet sheet, int rowNum, int colNum)
void	resetArea(AreaRef areaRef)
void	setFormula(CellRef cellRef, String formulaString)
void	setHidden(String sheetName, boolean hidden)
void	setInputStream(InputStream is)
void	setLastCommentedColumn(Integer lastCommentedColumn)
void	setOutputStream(OutputStream outputStream)
void	transform(CellRef srcCellRef, CellRef targetCellRef, Context context, boolean updateRowHeightFlag)
protected void	transformCell(CellRef srcCellRef, CellRef targetCellRef, Context context, boolean updateRowHeightFlag, CellData cellData, org.apache.poi.ss.usermodel.Sheet destSheet, org.apache.poi.ss.usermodel.Row destRow)
void	updateRowHeight(String srcSheetName, int srcRowNum, String targetSheetName, int targetRowNum)
void	write()

Methods inherited from class org.jxls.transform.AbstractTransformer

getCellData, getFormulaCells, getTargetCellRef, getTransformationConfig, isIgnoreColumnProps, isIgnoreRowProps, resetTargetCellRefs, setIgnoreColumnProps, setIgnoreRowProps, setTransformationConfig

Methods inherited from class java.lang.Object

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

Field Detail

POI_CONTEXT_KEY

public static final String POI_CONTEXT_KEY

See Also:

Constant Field Values

Constructor Detail

PoiTransformer

public PoiTransformer(org.apache.poi.ss.usermodel.Workbook workbook,
                      boolean streaming)

Parameters:

workbook - source workbook to transform

streaming - false: without streaming, true: with streaming (with default parameter values)

PoiTransformer

public PoiTransformer(org.apache.poi.ss.usermodel.Workbook workbook,
                      boolean streaming,
                      int rowAccessWindowSize,
                      boolean compressTmpFiles,
                      boolean useSharedStringsTable)

Parameters:

workbook - source workbook to transform

streaming - flag to set if SXSSF stream support is enabled

rowAccessWindowSize - only used if streaming is true

compressTmpFiles - only used if streaming is true

useSharedStringsTable - only used if streaming is true

Method Detail

isStreaming

protected boolean isStreaming()

setInputStream

public void setInputStream(InputStream is)

createTransformer

public static PoiTransformer createTransformer(InputStream is,
                                               OutputStream os)
                                        throws IOException,
                                               org.apache.poi.openxml4j.exceptions.InvalidFormatException

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException

createTransformer

public static PoiTransformer createTransformer(InputStream is)
                                        throws IOException,
                                               org.apache.poi.openxml4j.exceptions.InvalidFormatException

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException

createTransformer

public static PoiTransformer createTransformer(org.apache.poi.ss.usermodel.Workbook workbook)

createSxssfTransformer

public static PoiTransformer createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook)

createSxssfTransformer

public static PoiTransformer createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook,
                                                    int rowAccessWindowSize,
                                                    boolean compressTmpFiles)

createSxssfTransformer

public static PoiTransformer createSxssfTransformer(org.apache.poi.ss.usermodel.Workbook workbook,
                                                    int rowAccessWindowSize,
                                                    boolean compressTmpFiles,
                                                    boolean useSharedStringsTable)

createInitialContext

public static Context createInitialContext()

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

getLastCommentedColumn

public Integer getLastCommentedColumn()

setLastCommentedColumn

public void setLastCommentedColumn(Integer lastCommentedColumn)

transform

public void transform(CellRef srcCellRef,
                      CellRef targetCellRef,
                      Context context,
                      boolean updateRowHeightFlag)

isTransformable

protected CellData isTransformable(CellRef srcCellRef,
                                   CellRef targetCellRef)

transformCell

protected void transformCell(CellRef srcCellRef,
                             CellRef targetCellRef,
                             Context context,
                             boolean updateRowHeightFlag,
                             CellData cellData,
                             org.apache.poi.ss.usermodel.Sheet destSheet,
                             org.apache.poi.ss.usermodel.Row destRow)

resetArea

public void resetArea(AreaRef areaRef)

copyMergedRegions

protected final void copyMergedRegions(CellData sourceCellData,
                                       CellRef destCell)

findAndRemoveExistingCellRegion

protected final void findAndRemoveExistingCellRegion(CellRef cellRef)

setFormula

public void setFormula(CellRef cellRef,
                       String formulaString)

clearCell

public void clearCell(CellRef cellRef)

getRowForClearCell

protected org.apache.poi.ss.usermodel.Row getRowForClearCell(org.apache.poi.ss.usermodel.Sheet sheet,
                                                             CellRef cellRef)

removeCellComment

protected final void removeCellComment(org.apache.poi.ss.usermodel.Sheet sheet,
                                       int rowNum,
                                       int colNum)

getCommentedCells

public List<CellData> getCommentedCells()

addImage

public void addImage(AreaRef areaRef,
                     byte[] imageBytes,
                     ImageType imageType)

write

public void write()
           throws IOException

Throws:

IOException

dispose

public void dispose()

Specified by:

dispose in interface Transformer

Overrides:

dispose in class AbstractTransformer

getOutputStream

public OutputStream getOutputStream()

setOutputStream

public void setOutputStream(OutputStream outputStream)

getInputStream

public InputStream getInputStream()

getCellStyle

public org.apache.poi.ss.usermodel.CellStyle getCellStyle(CellRef cellRef)

deleteSheet

public boolean deleteSheet(String sheetName)

Specified by:

deleteSheet in interface Transformer

Overrides:

deleteSheet in class AbstractTransformer

setHidden

public void setHidden(String sheetName,
                      boolean hidden)

updateRowHeight

public void updateRowHeight(String srcSheetName,
                            int srcRowNum,
                            String targetSheetName,
                            int targetRowNum)

getXSSFWorkbook

public org.apache.poi.xssf.usermodel.XSSFWorkbook getXSSFWorkbook()

Returns:

xls = null, xlsx = XSSFWorkbook, xlsx with streaming = the inner XSSFWorkbook instance

adjustTableSize

public void adjustTableSize(CellRef ref,
                            Size size)

Specified by:

adjustTableSize in interface Transformer

Overrides:

adjustTableSize in class AbstractTransformer

mergeCells

public void mergeCells(CellRef cellRef,
                       int rows,
                       int cols)

Specified by:

mergeCells in interface Transformer

Overrides:

mergeCells in class AbstractTransformer