com.github.pjfanning.poi.xssf.streaming

Class SXSSFFactory

java.lang.Object

org.apache.poi.ooxml.POIXMLFactory

org.apache.poi.xssf.usermodel.XSSFFactory

com.github.pjfanning.poi.xssf.streaming.SXSSFFactory

public class SXSSFFactory
extends XSSFFactory

Can be used with XSSFWorkbook or SXSSFWorkbook constructors to override the implementation of CommentsTable and/or SharedStringsTable. This factory only supports TempFileCommentsTable and TempFileSharedStringsTable.

See Also:

an alternative factory class that allows you more control of the injected CommentsTable and SharedStringsTable implementations.

Constructor Summary

Constructors

Constructor and Description
SXSSFFactory()
SXSSFFactory(boolean encryptTempFiles) Deprecated. use #encryptTempFiles method instead

Method Summary

Modifier and Type	Method and Description
SXSSFFactory	enableTempFileComments(boolean enableTempFileComments)
SXSSFFactory	enableTempFileSharedStrings(boolean enableTempFileSharedStrings)
SXSSFFactory	encryptTempFiles(boolean encryptTempFiles)
POIXMLDocumentPart	newDocumentPart(POIXMLRelation descriptor)

Methods inherited from class org.apache.poi.xssf.usermodel.XSSFFactory

getDescriptor, getInstance

Methods inherited from class org.apache.poi.ooxml.POIXMLFactory

createDocumentPart, getPackageRelationship

Methods inherited from class java.lang.Object

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

Constructor Detail

SXSSFFactory

public SXSSFFactory()

SXSSFFactory

@Deprecated
public SXSSFFactory(boolean encryptTempFiles)

Deprecated. use #encryptTempFiles method instead

Parameters:

encryptTempFiles - whether to encrypt the temp files

Method Detail

encryptTempFiles

public SXSSFFactory encryptTempFiles(boolean encryptTempFiles)

Parameters:

encryptTempFiles - whether to encrypt the temp files

Returns:

this factory instance

enableTempFileSharedStrings

public SXSSFFactory enableTempFileSharedStrings(boolean enableTempFileSharedStrings)

Parameters:

enableTempFileSharedStrings - whether to enable temp file shared strings table (default is true)

Returns:

this factory instance

Since:

v2.2.2

enableTempFileComments

public SXSSFFactory enableTempFileComments(boolean enableTempFileComments)

Parameters:

enableTempFileComments - whether to enable temp file comments table (default is false)

Returns:

this factory instance

Since:

v2.3.0

newDocumentPart

public POIXMLDocumentPart newDocumentPart(POIXMLRelation descriptor)

Overrides:

newDocumentPart in class POIXMLFactory