Release Notes

v3.0.0

• Java 17
• see migration guide
• new website, cover photo by Domagoj Ćosić
• We advise against using POI > 5.2.2.

v2.14.0

• This is the last Java 8 release.
• #251 lastCommentedColumn not necessary anymore
  Breaking change: You just have to remove calls to setLastCommentedColumn() and everything works.
• #271 fix: memory leak in streaming Excel processing - Thanks to giuseppemilicia
• #281 logback 1.2.13 - Thanks to vgaur

v2.13.0

• #178 Java 17 - Thanks to mosidev
• #209 Use of groupBy and select
  Breaking change: If jx:each groupBy and select are specified the filtering will now be done before the grouping. ".item" must then be removed from the select expression. We think the old processing order makes no sense and is used by nobody. If you really need the old processing order give us an information in #209 and set jx:each parameter oldSelectBehavior="true".
• #235 POI 5.2.2 - Thanks to Sivakumar-finoli
  We advise against using POI 5.2.3. POI 5.2.2 can be used. An Apache POI bug ticket 66687 has been created. Bug came from 65562.
  We've also created 66679 because of potential problems with cell type General.
• #237 made getSheetsNameOfMultiSheetTemplate() public
• #244 JxlsNationalLanguageSupport problems

v2.12.0

• #164 Update commons-compress
• #147 Row height bugfix, contribution by jools-uk
• #153 Issue in Excel Output while using SXSSF Transformer
• #148 Inconsistent use of var prefix in EachCommand
  You should write var+"." before each property name in orderBy and groupBy.
• #129 GroupSum with condition see example: GroupSumTest
• #73 Exceptions not propagated in EachCommand

With change #73 it's possible to throw exceptions instead of logging them as ERROR:

transformer.setExceptionHandler(new PoiExceptionThrower());
transformer.getTransformationConfig().setExpressionEvaluator(new JexlExpressionEvaluator(false, true));

v2.11.0

The release contains an upgrade of JEXL library and a fix for XXE vulnerability

• #131 JEXL 3.2
• #143 Vulnerability alert

v2.10.0

New features and fixed bugs

• #78 Add support for JSR310 types (aka Java Time API), contribution by wagnerluis1982
• #79 Multi-line and comment support for SQL queries in jx:each, contribution by alexlust
• #85 Distinguish between unknown key and run var
• #87 Formula recalculation, contribution by Turbocube644
• #93 Backup/restore varIndex in jx:each
• #108 bug in 2.10.0 RC1: Don't call getRunVar with null
• #111 bug in 2.10.0 RC2: LiteralsExtractor buggy

other resolved issues:

• #75 Documented varIndex argument, contribution by sapradhan
• #90 Escaping single quotes in query is possible

v2.9.0

With this version we migrated from BitBucket to Github.

A list of resolved issues

• #1: Javadoc
• #2: moved jxls-site into main repo
• #8: Gradle
• #13: Code coverage
• #15: Java 8
• #19: B prefix for BitBucket issue related testcase classes
• #25: read-only mode when open Excel files in tests
• #27: changes from 2.8.1, see below and BitBucket issue 210
• #50: POI 4.1.2, commons-beanutils 1.9.4, slf4j
• #53: CLOB fix
• #64: don't read iterable ahead of time (jx:each bugfix)
• #68: workaround for POI bug: unset value after changing a formula (streaming mode)

v2.8.1

The release contains a critical bug-fix for a specific case of formulas processing. See issue#210 SUM with empty lists when more than 1 sheet doesn't work for more detail.

v2.8.0

The release brings many bug-fixes and some improvements, in particular

• National language support
• Excel conditional formatting support for jx:each command issue #110
• JxlsTester for writing template based testcases. See Jxls source page for more information.
• Order-by for jx:each command

A list of resolved issues

• issue#90 Allow Excel formulas to work with jx:grid contribution by Matthias Lung
• issue#133 Group by nested property
• issue#155 Table and PivotTable support does not work with dynamic column names = National language support
• issue#183 Util.transformToIterableObject should say whether a var is null
• issue#185 Better error message for corrupt Excel file
• issue#186 Standardized testcases
• issue#193 Add orderBy to jx:each command
• issue#195 Add logback-classic for tests
• issue#196 groupBy and groupOrder support for XML markup
• issue#197 Jointed cell references don't work anymore with several empty collections
• issue#198 Array support for EachCommand
• issue#200 Treat null in EachCommand items as empty collection
• issue#201 Fix broken links
• issue#204 Order of conditional formatting rules is not preserved on copying
• issue#206 Each with RIGHT next to each other does not work
• issue#207 IndexOutOfBoundsException in StandardFormulaProcessor

Compatibility notes and future plans

• Signature of createTransformer() has been changed. The throws has been removed. Now the unchecked CannotOpenWorkbookException will be thrown.
• jx:each and jx:grid now treat null lists as empty lists (see issue#200 )
• POI 4.0 requires Java 8 and so it is the recommended version to use. Jxls code base will be migrated to Java 8 syntax in the upcoming versions.
• The major change in 2.9.0 will be the move to Github. Our homepage and publishing to Maven-central will stay the same.

v2.7.2

This release fixes issue#188 Referencing other sheet in Jxls-processed cell formula replaces formula with "=0" .

Also it reverts back the behaviour from previous Jxls releases (2.6.0 and earlier) where the POI formulas evaluation was not triggered by default. See corresponding section on Excel Formulas page for more information on how to enable POI formulas evaluation if you need it.

v2.7.1

This is a bugfix release fixing the following issue

• issue#184 jx:if within jx:each may cause problem

v2.7.0

Besides many bug-fixes (see below) this release has the following changes

• Added POI 4.1.0 compatibility
• Introduced varIndex variable to get iteration index in jx:each
• Removed Jexcel module

bug-fixes and changes:

• issue#72 Group sum (contribution by Marcus Warm)
• issue#97 'jx:each' command not processing Division formula having cell ref outside each
• issue#108 setDeleteTemplateSheet(true) doesn't work
• issue#127 Problem with formulas referencing cells in another worksheet containing special characters in name
• issue#132 delete multi sheet template
• issue#149 Pre-evaluating (excel) formulas during template processing
• issue#157 jx:each select attribute limited expression evaluation context
• issue#158 Row can be null in SelectSheetsForStreamingPoiTransformer (NPE) (contribution by Marcus Warm)
• issue#159 Insert image issues (contribution by ZhengJin Fang)
• issue#160 jx:each with direction=RIGHT with SXSSF Transformer rewrites static cells
• issue#161 Multisheet names longer than 31 letters are not gracefully handled
• issue#162 Bug in parameterized Excel Formulas
• issue#164 Remove Jexcel
• issue#166 Excel AVERAGE function in template not working properly
• issue#168 POI 4.1.0 will raise errors on org.jxls.area.XlsArea#transformTopStaticArea
• issue#169 Trim comment before checking if it's a JxlsxParams comment
• issue#173 how can I get index in jx:each
• issue#174 NullPointer thrown if cell has empty comment
• issue#180 Nested sums

v2.6.0

• 2.6.x is the last version with jxls-jexcel support. Please use jxls-poi.
• issue#136 Added MergeCellsCommand (contribution by lnk)
• issue#138 Upgrade JEXL to v3.1
  You must change the package from jexl2 to jexl3. Now adding custom functions works like this: evaluator.setJexlEngine(new JexlBuilder().namespaces(functionMap).create());
• issue#139 Upgrade 3rd-party dependencies
• issue#142 Increase test coverage
• issue#143 Removed AreaCommand.clearCells
• issue#144 If/else-Each-If/else testcase
• issue#137 Moved jxls-poi sources into jxls repo
• issue#140 Moved jxls-demo sources into jxls repo
• issue#141 Improved code quality (contribution by Leonid and Marcus)

v2.5.1

Added a default implementation for the Transformer.adjustTableSize method to make jxls-2.5.x compatible with the previous releases of jxls-poi

v2.5.0

This release features Table support and an option to use an expression for multi-sheet generation.

Thanks to Marcus Warm and zangloo for the contributions!

jxls-2.5.0

• fixed issue#88 Table support
• Possibility to use an expression in multisheet property for sheet name (see Multiple sheets output for more info)
• fixed issue#117 Grouping null values
• fixed issue#129 Usage of Multi Sheet Markup with empty sheet names list causes IndexOutOfBoundsException
• fixed issue#134 Optimize Context.getVar(String)

jxls-poi-1.1.0

• fixed issue#88 Table support
• fixed issue#104 Extending PoiTransformer is hard
• fixed issue#14 POI 4.0.1 support

jxls-jexcel-1.0.8

• issue#88 No table support for jxls-jexcel

v2.4.7

jxls-2.4.7

• fixed issue#125 Allow passing null image to ImageCommand
• fixed issue#124 Optimizing XlsArea:findCommandsForVerticalShift recursive method
• fixed issue#122 Wrong cell replacement

jxls-poi-1.0.16

• support for Apache POI 4.0.0

jxls-reader-2.0.5

• support for Apache POI 4.0.0
• reverted the fix for "XLSBlockReader startRow/endRow not work" merged earlier in PR#5

v2.4.6

• issue#111 StandardFormulaProcessor is now the default formula processor for XlsArea and JxlsHelper
• issue#116 Formula handling issues (formula external to any jx:area)

v2.4.5

The following issues have been fixed

• issue#100 Cell format not being correctly shifted with an empty list
• issue#103 Cell format not being correctly shifted when having Jxls command and empty list
• issue#105 Issue with 'big double values' (like 1.3E22) being parsed as cell references (like E22)
• issue#106 Issue with row height and jxls2 root not in A1
• issue#107 Issue with formatting of parts of text

v2.4.4

• issue#26 FastFormulaProcessor has a buggy replacement strategy

v2.4.3

• issue#92 Make JxlsHelper extensible
• issue#84 Allow using of Iterables in Each command
• issue#8 Jxls is not compatible with POI 3.17
• issue#9 Avoid using deprecated POI API

v2.4.2

This a bug-fix release fixing

• issue#85: Wrong sum in multisheet

v2.4.1

This release features several bug-fixes and a few improvements

• issue#74: Use Resultsets on Jxls library
• issue#77: Jxls Losing rows when using if-command inside each-command
• issue#80: Cannot export more than 256 columns into .xlsx
• issue#78: ConvertUtils is not thread safe
• issue#81: ignore collection parse error in each-command
• issue#82: restore the original varName object value in each-command
• Using ServiceFactory SPI to load ExpressionEvaluator implementation

v2.4.0

This release features

• UpdateCellCommand for cell processing customization
• Grouping support in EachCommand

The following bugs have been fixed

• issue#58: Using sxssfTransformer formulas weren't generated properly
• issue#42: Formula processing mechanism
• issue#59: SUM with more than 255 parameters
• issue#53: NullPointerException is thrown when IfCommand condition is false
• issue#65: NullPointerException is thrown when excel template have multiple MergedRegions
• issue#54: jxls 2.3.0 memory leak when using on Tomcat
• issue#64: "areas" regex does not handle whitespace
• issue#33: can not processFormulas while use createSxssfTransformer

v2.3.0

Now you can use a markup in Excel template to output a collection into multiple sheets. See Multiple sheets output section and Multi sheet markup example

Also the following issues have been fixed

• issue#35 Each command problem with row contain if command
• issue#23 Each-command with direction "RIGHT" doesn't shift outer columns
• issue#32 Deletion of sheet fails
• issue#45 Incorrect row height is set in Each-command
• issue#25 Row heights reset between parameterized cells
• jxls-poi issue#1 PoiTransformer MAX_COLUMN_TO_READ_COMMENT should be configurable property
• jxls-poi issue#2 Printing context to log in case of Exception and huge context pollutes log file
• jxls-poi issue#3 Display gridlines property is not correctly copied
• jxls-poi issue#4 Provide Shared String Table Option for SXSSF Transformer
• jxls-jexcel issue#1 CellType.DATE is not written to a template

There are also the following api changes

• Method createInitialContext() was removed from Transformer interface

  The static method of the same name in PoiTransformer and JexcelTransformer can now be used for the same purpose (e.g. PoiTransformer.createInitialContext())

• transform method in Transformer interface is now taking an additional parameter boolean updateRowHeight indicating if a row height needs to be updated

• A new method void updateRowHeight(String srcSheetName, int srcRowNum, String targetSheetName, int targetRowNum) is added to Transformer interface to copy row height from a source row to a target row.

v2.2.9

The following issues were fixed

• Fixed issue#34 Each-command problem with the merge cells
• Fixed issue#36 Huge performance issue with debug logging
• Fixed issue#37 Don't obtrude a logging framework

v2.2.8

This release features some bug-fixes and improvements

• An option to set a default formula value (see Excel formulas for more details)
• Class api improvements by adding method chaining to JxlsHelper and CellRef classes (contributed by Karri-Pekka Laakso)
• Fixed issue#24 by adding isFormulaProcessingRequired attribute to Context.Config
• Fixed issue#29
• Fixed issue#27
• Fixed issue#30

v2.2.7

• Added an option to use SQL queries in Excel Template. See Database page.
• Added an option to specify formula strategy for any given formula allowing to adjust formula calculation
  (you can find a demo of this functionality in FormulaCopyDemo example in jxls-demo project)

v2.2.6

Fixed an error when processing an area with multiple nested commands issue#21

v2.2.5

Improvements for ImageCommand

• imgBean attribute is now renamed to src and supports any expression resulting in image byte array byte[]

v2.2.4

• EachCommand now supports setting of direction attribute in Excel template with a text value DOWN or RIGHT
• Minor refactoring: replacing StringBuffer with StringBuilder

v2.2.3

This is a bug-fix release. The following issues were fixed

• issue #9 No obvious behavior using Each-Command
• issue #11 Problem with complex formulas

v2.2.2

This is a bug-fix release. The following issues were fixed

• issue #8 Bug at using nested formulas
• issue #10 Final width of a grid is not calculated properly

v2.2.1

• Better support for SXSSF templates
• JxlsHelper class to simplify the library usage. Getting started guide and some of the examples were updated to use JxlsHelper.

v2.2.0

###New features

• Possibility to replace JEXL with another expression language engine (see expression language)
• Possibility to replace the default ${} expression notation with the one you like (e.g. [[]])

###Bugs fixed

• Bug when using right direction each command

v2.1.1

This release introduces SimpleExporter that allows you to generate an excel with a single line of code and without necessity to provide a template file.

v2.1.0

This release introduces new Grid Command and contains the following bug-fixes

• NPE in IfCommand create Excel Markup
• Free rows when 2 adjacent collections

v2.0.0

First public release for Jxls-2.

Jxls-2 is a full rewrite from scratch of the original Jxls 1.x library to make it much more flexible and improve the performance.

Jxls-2 completely de-couples itself from the underlying Java-to-Excel transformation engine so that it is possible to switch low-level Java-to-Excel library without any code changes.

Excel template markup can now be redefined in a way you like.

Jxls-2 introduces a concept of Command to replace previously used tags (like jx:forEach, jx:if). Command is not tied to any particular Excel mark-up. In fact it can be defined completely in Java or by using built-in Excel-comment or XML-based mark-ups.

Custom post- and pre- processing code can now also be easily injected into Excel transformation.

Please note that Jxls-2 is not backwards compatible with Jxls 1.x.

If you wish to upgrade your existing Jxls 1.x reports for Jxls-2 you will have to rewrite the code and change the notation in XLS template.