org.jxls.util

Class JxlsHelper

java.lang.Object

org.jxls.util.JxlsHelper

public class JxlsHelper
extends Object

Helper class to simplify JXLS usage

Constructor Summary

Constructors

Constructor and Description
JxlsHelper()

Method Summary

Modifier and Type	Method and Description
JxlsHelper	buildExpressionNotation(String expressionNotationBegin, String expressionNotationEnd) Allows to set custom notation for expressions in the template The notation is used in createTransformer(InputStream, OutputStream)
ExpressionEvaluator	createExpressionEvaluator(String expression) Creates ExpressionEvaluator instance for evaluation of the given expression
Transformer	createTransformer(InputStream templateStream, OutputStream targetStream) Creates Transformer instance connected to the given input stream and output stream with the default or custom expression notation (see also buildExpressionNotation(String, String)
AreaBuilder	getAreaBuilder()
ExpressionEvaluatorFactory	getExpressionEvaluatorFactory()
FormulaProcessor	getFormulaProcessor()
static JxlsHelper	getInstance() Returns new JxlsHelper instance
static String	getProperty(String key, String defaultValue) Returns the configuration property value
JxlsHelper	gridExport(Collection<?> headers, Collection<?> dataObjects, String objectProps, OutputStream outputStream) Performs data grid export using SimpleExporter
boolean	isDeleteTemplateSheet()
boolean	isEvaluateFormulas() This property is used to recalculate all formulas before saving the workbook.
boolean	isFullFormulaRecalculationOnOpening()
boolean	isHideTemplateSheet()
boolean	isProcessFormulas()
boolean	isUseFastFormulaProcessor()
JxlsHelper	processGridTemplate(InputStream templateStream, OutputStream targetStream, Context context, String objectProps) Processes the template with the GridCommand
void	processGridTemplateAtCell(InputStream templateStream, OutputStream targetStream, Context context, String objectProps, String targetCell) Processes the input template with GridCommand at given target cell using the given object properties and context
void	processTemplate(Context context, Transformer transformer) Processes a template with the given Transformer instance and Context
JxlsHelper	processTemplate(InputStream templateStream, OutputStream targetStream, Context context) Reads template from the source stream processes it using the supplied Context and writes the result to the target stream
JxlsHelper	processTemplateAtCell(InputStream templateStream, OutputStream targetStream, Context context, String targetCell) Processes the template from the given input stream using the supplied Context and the given target cell and writes the result to the output stream
JxlsHelper	registerGridTemplate(InputStream inputStream) Registers grid template to be used with SimpleExporter
JxlsHelper	setAreaBuilder(AreaBuilder areaBuilder)
JxlsHelper	setDeleteTemplateSheet(boolean deleteTemplateSheet) Marks template sheet for deletion
JxlsHelper	setEvaluateFormulas(boolean evaluateFormulas) This property is used to recalculate all formulas before saving the workbook.
JxlsHelper	setFormulaProcessor(FormulaProcessor formulaProcessor) Sets formula processor implementation
JxlsHelper	setFullFormulaRecalculationOnOpening(boolean fullFormulaRecalculationOnOpening) If you set this option to true, all formulas will be recalculated when the file is opened in MS Excel.
JxlsHelper	setHideTemplateSheet(boolean hideTemplateSheet) Hides/shows template sheet
JxlsHelper	setProcessFormulas(boolean processFormulas) Enables or disables formula processing
JxlsHelper	setUseFastFormulaProcessor(boolean useFastFormulaProcessor)

Methods inherited from class java.lang.Object

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

Constructor Detail

JxlsHelper

public JxlsHelper()

Method Detail

getInstance

public static JxlsHelper getInstance()

Returns new JxlsHelper instance

Returns:

JxlsHelper object

isEvaluateFormulas

public boolean isEvaluateFormulas()

This property is used to recalculate all formulas before saving the workbook. This property is set to true if you don't open the file with MS Excel and just read it (e.g. with a unit test). The following documentation is POI specific.

Returns:

true: calls workbook.getCreationHelper().createFormulaEvaluator().evaluateAll() before writing the workbook. Please have a look at the POI documentation for more details. This does not work for streaming. Please be aware that POI supports only a subset of Excel formulas. If an unsupported formula is in the template the evaluation will fail.

false (default): do nothing (hopefully MS Excel will recalculate all formulas while opening the file)

setEvaluateFormulas

public JxlsHelper setEvaluateFormulas(boolean evaluateFormulas)

This property is used to recalculate all formulas before saving the workbook. This property is set to true if you don't open the file with MS Excel and just read it (e.g. with a unit test).

Don't do this:
JxlsHelper.getInstance().setEvaluateFormulas(true);
JxlsHelper.getInstance().processTemplate(...);
Call JxlsHelper.getInstance() only once!

The following documentation is POI specific.

Parameters:

evaluateFormulas - true: calls workbook.getCreationHelper().createFormulaEvaluator().evaluateAll() before writing the workbook. Please have a look at the POI documentation for more details. This does not work for streaming. Please be aware that POI supports only a subset of Excel formulas. If an unsupported formula is in the template the evaluation will fail.

false (default): do nothing (hopefully MS Excel will recalculate all formulas while opening the file)

Returns:

this

isFullFormulaRecalculationOnOpening

public boolean isFullFormulaRecalculationOnOpening()

Returns:

false: do nothing, true: activate recalculation when opening

setFullFormulaRecalculationOnOpening

public JxlsHelper setFullFormulaRecalculationOnOpening(boolean fullFormulaRecalculationOnOpening)

If you set this option to true, all formulas will be recalculated when the file is opened in MS Excel. This changes the Excel file. This only works once.

Parameters:

fullFormulaRecalculationOnOpening - false: do nothing (default value), true: activate recalculation when opening

Returns:

this

getAreaBuilder

public AreaBuilder getAreaBuilder()

setAreaBuilder

public JxlsHelper setAreaBuilder(AreaBuilder areaBuilder)

getFormulaProcessor

public FormulaProcessor getFormulaProcessor()

Returns:

current FormulaProcessor implementation

setFormulaProcessor

public JxlsHelper setFormulaProcessor(FormulaProcessor formulaProcessor)

Sets formula processor implementation

Parameters:

formulaProcessor - FormulaProcessor instance

Returns:

this

isProcessFormulas

public boolean isProcessFormulas()

Returns:

true if formula processing is on

setProcessFormulas

public JxlsHelper setProcessFormulas(boolean processFormulas)

Enables or disables formula processing

Parameters:

processFormulas - enable/disable formula processing flag

Returns:

this

isHideTemplateSheet

public boolean isHideTemplateSheet()

Returns:

true if template sheet must be hidden

setHideTemplateSheet

public JxlsHelper setHideTemplateSheet(boolean hideTemplateSheet)

Hides/shows template sheet

Parameters:

hideTemplateSheet - true to hide template sheet or false to show it

Returns:

this

isDeleteTemplateSheet

public boolean isDeleteTemplateSheet()

Returns:

flag indicating if template sheet must be deleted

setDeleteTemplateSheet

public JxlsHelper setDeleteTemplateSheet(boolean deleteTemplateSheet)

Marks template sheet for deletion

Parameters:

deleteTemplateSheet - true if template sheet should be deleted

Returns:

this

isUseFastFormulaProcessor

public boolean isUseFastFormulaProcessor()

Returns:

true if FastFormulaProcessor should be used

setUseFastFormulaProcessor

public JxlsHelper setUseFastFormulaProcessor(boolean useFastFormulaProcessor)

Parameters:

useFastFormulaProcessor - if true the FastFormulaProcessor will be used to process formulas otherwise StandardFormulaProcessor will be used

Returns:

this

buildExpressionNotation

public JxlsHelper buildExpressionNotation(String expressionNotationBegin,
                                          String expressionNotationEnd)

Allows to set custom notation for expressions in the template The notation is used in createTransformer(InputStream, OutputStream)

Parameters:

expressionNotationBegin - notation prefix

expressionNotationEnd - notation suffix

Returns:

this

processTemplate

public JxlsHelper processTemplate(InputStream templateStream,
                                  OutputStream targetStream,
                                  Context context)
                           throws IOException

Reads template from the source stream processes it using the supplied Context and writes the result to the target stream

Parameters:

templateStream - source input stream with the template

targetStream - target output stream

context - data map

Returns:

this

Throws:

IOException - -

processTemplate

public void processTemplate(Context context,
                            Transformer transformer)
                     throws IOException

Processes a template with the given Transformer instance and Context

Parameters:

context - data context

transformer - transformer instance

Throws:

IOException - -

getProperty

public static String getProperty(String key,
                                 String defaultValue)

Returns the configuration property value

Parameters:

key - property key

defaultValue - default value to use if undefined

Returns:

property value or the passed default value if the property not found

getExpressionEvaluatorFactory

public ExpressionEvaluatorFactory getExpressionEvaluatorFactory()

Returns:

current ExpressionEvaluatorFactory implementation

createExpressionEvaluator

public ExpressionEvaluator createExpressionEvaluator(String expression)

Creates ExpressionEvaluator instance for evaluation of the given expression

Parameters:

expression - expression to evaluate

Returns:

ExpressionEvaluator instance for evaluation the passed expression

processTemplateAtCell

public JxlsHelper processTemplateAtCell(InputStream templateStream,
                                        OutputStream targetStream,
                                        Context context,
                                        String targetCell)
                                 throws IOException

Processes the template from the given input stream using the supplied Context and the given target cell and writes the result to the output stream

Parameters:

templateStream - source input stream for the template

targetStream - target output stream to write the processing result

context - data map

targetCell - starting target cell into which the template area must be processed

Returns:

this

Throws:

IOException - if input/output stream processing resolves in an error

processGridTemplate

public JxlsHelper processGridTemplate(InputStream templateStream,
                                      OutputStream targetStream,
                                      Context context,
                                      String objectProps)
                               throws IOException

Processes the template with the GridCommand

Parameters:

templateStream - template input stream

targetStream - output stream for the result

context - data map

objectProps - object properties to use with the GridCommand

Returns:

this

Throws:

IOException - -

processGridTemplateAtCell

public void processGridTemplateAtCell(InputStream templateStream,
                                      OutputStream targetStream,
                                      Context context,
                                      String objectProps,
                                      String targetCell)
                               throws IOException

Processes the input template with GridCommand at given target cell using the given object properties and context

Parameters:

templateStream - template input stream

targetStream - result output stream

context - data map

objectProps - object properties to use with GridCommand

targetCell - start target cell to use when processing the template

Throws:

IOException - -

registerGridTemplate

public JxlsHelper registerGridTemplate(InputStream inputStream)
                                throws IOException

Registers grid template to be used with SimpleExporter

Parameters:

inputStream - template input stream

Returns:

this

Throws:

IOException - -

gridExport

public JxlsHelper gridExport(Collection<?> headers,
                             Collection<?> dataObjects,
                             String objectProps,
                             OutputStream outputStream)

Performs data grid export using SimpleExporter

Parameters:

headers - collection of headers to use for the export

dataObjects - collection of data objects to export

objectProps - object properties (comma separated) to use with the GridCommand

outputStream - output stream to write the processing result

Returns:

this

createTransformer

public Transformer createTransformer(InputStream templateStream,
                                     OutputStream targetStream)

Creates Transformer instance connected to the given input stream and output stream with the default or custom expression notation (see also buildExpressionNotation(String, String)

Parameters:

templateStream - source template input stream

targetStream - target output stream to write the processing result

Returns:

created transformer