JxlsHelper removal

Use JxlsPoiTemplateFillerBuilder instead! See migration guide.
jxlsteam · Dec 27, 2023 · b30143c · b30143c
1 parent f43aa9c
commit b30143c
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 25 deletions.
diff --git a/jxls-poi/src/main/java/org/jxls/transform/poi/PoiCellData.java b/jxls-poi/src/main/java/org/jxls/transform/poi/PoiCellData.java
@@ -19,6 +19,7 @@
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.util.CellReference;
 import org.apache.poi.xssf.usermodel.XSSFCell;
+import org.jxls.command.EachCommand;
 import org.jxls.common.CellData;
 import org.jxls.common.CellRef;
 import org.jxls.common.Context;
@@ -149,8 +150,9 @@ public void writeToCell(Cell cell, Context context, PoiTransformer transformer)
             updateCellGeneralInfo(cell);
             updateCellContents(cell);
             CellStyle targetCellStyle = cellStyle;
-            if (Boolean.TRUE.equals(context.getRunVar(CellData.IGNORE_SOURCE_CELL_STYLE) )) {
-                CellStyle dataFormatCellStyle = findCellStyle(evaluationResult, (Map<String, String>) context.getRunVar(CellData.CELL_STYLE_MAP), transformer);
+            if (Boolean.TRUE.equals(EachCommand.getRunVar(context, CellData.IGNORE_SOURCE_CELL_STYLE) )) {
+                Map<String, String> cellStyleMap = (Map<String, String>) EachCommand.getRunVar(context, CellData.CELL_STYLE_MAP);
+                CellStyle dataFormatCellStyle = findCellStyle(evaluationResult, cellStyleMap, transformer);
                 if (dataFormatCellStyle != null) {
                     targetCellStyle = dataFormatCellStyle;
                 }

diff --git a/jxls-poi/src/test/java/org/jxls/templatebasedtests/Issue85Test.java b/jxls-poi/src/test/java/org/jxls/templatebasedtests/Issue85Test.java
@@ -30,6 +30,7 @@ public MyMap() {
 
         @Override
         public Object get(Object key) {
+            if ("jx:isFormulaProcessingRequired".equals(key)) return null; // TODO
             if (!containsKey(key)) {
                 throw new IllegalArgumentException("Map does not contain key: " + key);
             }

diff --git a/jxls/src/main/java/org/jxls/area/XlsArea.java b/jxls/src/main/java/org/jxls/area/XlsArea.java
@@ -6,6 +6,7 @@
 import java.util.Set;
 
 import org.jxls.command.Command;
+import org.jxls.command.EachCommand;
 import org.jxls.common.AreaListener;
 import org.jxls.common.AreaRef;
 import org.jxls.common.CellData;
@@ -232,7 +233,7 @@ public Size applyAt(CellRef cellRef, Context context) {
         transformStaticCells(cellRef, context, commandsArea);
         fireAfterApplyEvent(cellRef, context);
         Size finalSize = new Size(cellRange.calculateWidth(), cellRange.calculateHeight());
-        if (!Boolean.FALSE.equals(context.getRunVar(IS_FORMULA_PROCESSING_REQUIRED))) {
+        if (!Boolean.FALSE.equals(EachCommand.getRunVar(context, IS_FORMULA_PROCESSING_REQUIRED))) {
             AreaRef newAreaRef = new AreaRef(cellRef, finalSize);
             updateCellDataFinalAreaForFormulaCells(newAreaRef);
         }
@@ -525,7 +526,7 @@ private void transformStaticCells(CellRef cellRef, Context context,
     }
 
     private void updateCellDataArea(CellRef srcCell, CellRef targetCell, Context context) {
-        if (Boolean.FALSE.equals(context.getRunVar(IS_FORMULA_PROCESSING_REQUIRED))) {
+        if (Boolean.FALSE.equals(EachCommand.getRunVar(context, IS_FORMULA_PROCESSING_REQUIRED))) {
             return;
         }
         CellData cellData = transformer.getCellData(srcCell);

diff --git a/jxls/src/main/java/org/jxls/command/CollectionProcessor.java b/jxls/src/main/java/org/jxls/command/CollectionProcessor.java
@@ -7,8 +7,8 @@ public abstract class CollectionProcessor {
 
     public void traverse(Context context, Iterable<?> itemsCollection, String varName, String varIndex,
             ExpressionEvaluator selectEvaluator) {
-        Object currentVarObject = varName == null ? null : context.getRunVar(varName);
-        Object currentVarIndexObject = varIndex == null ? null : context.getRunVar(varIndex);
+        Object currentVarObject = EachCommand.getRunVar(context, varName);
+        Object currentVarIndexObject = EachCommand.getRunVar(context, varIndex);
         int currentIndex = 0;
         for (Object obj : itemsCollection) {
             context.putVar(varName, obj);

diff --git a/jxls/src/main/java/org/jxls/command/EachCommand.java b/jxls/src/main/java/org/jxls/command/EachCommand.java
@@ -335,8 +335,8 @@ private void orderCollection(Iterable<?> itemsCollection) {
     private Iterable<?> filter(Context context, Iterable<?> itemsCollection, String selectExpression) {
         List<Object> filteredList = new ArrayList<>();
         ExpressionEvaluator selectEvaluator = getTransformationConfig().getExpressionEvaluator(selectExpression);
-        Object currentVarObject = var == null ? null : context.getRunVar(var);
-        Object currentVarIndexObject = varIndex == null ? null : context.getRunVar(varIndex);
+        Object currentVarObject = getRunVar(context, var);
+        Object currentVarIndexObject = getRunVar(context, varIndex);
         int currentIndex = 0;
         for (Object obj : itemsCollection) {
             context.putVar(var, obj);
@@ -373,8 +373,8 @@ private Size processCollection(Context context, Iterable<?> itemsCollection, Cel
         }
 
         CellRef currentCell = cellRef;
-        Object currentVarObject = varName == null ? null : context.getRunVar(varName);
-        Object currentVarIndexObject = varIndex == null ? null : context.getRunVar(varIndex);
+        Object currentVarObject = getRunVar(context, varName);
+        Object currentVarIndexObject = getRunVar(context, varIndex);
         int currentIndex = 0;
         for (Object obj : itemsCollection) {
             context.putVar(varName, obj);
@@ -414,6 +414,15 @@ private Size processCollection(Context context, Iterable<?> itemsCollection, Cel
         restoreVarObject(context, varName, currentVarObject);
         return new Size(newWidth, newHeight);
     }
+
+    public static Object getRunVar(Context context, String varName) {
+        if (varName != null) {
+            if (context.toMap().containsKey(varName)) {
+                return context.getRunVar(varName);
+            }
+        }
+        return null;
+    }
 
     private void restoreVarObject(Context context, String varName, Object varObject) {
         if (varName == null) {

diff --git a/jxls/src/main/java/org/jxls/command/GridCommand.java b/jxls/src/main/java/org/jxls/command/GridCommand.java
@@ -164,9 +164,9 @@ private Size processBody(final CellRef cellRef, Context context) {
         CellRef currentCell = cellRef;
         int totalWidth = 0;
         int totalHeight = 0;
-        Boolean oldIgnoreSourceCellStyle = (Boolean) context.getRunVar(CellData.IGNORE_SOURCE_CELL_STYLE);
+        Boolean oldIgnoreSourceCellStyle = (Boolean) EachCommand.getRunVar(context, CellData.IGNORE_SOURCE_CELL_STYLE);
         context.putVar(CellData.IGNORE_SOURCE_CELL_STYLE, Boolean.TRUE);
-        Map<String, String> oldStyleCellMap = (Map<String, String>) context.getRunVar(CellData.CELL_STYLE_MAP);
+        Map<String, String> oldStyleCellMap = (Map<String, String>) EachCommand.getRunVar(context, CellData.CELL_STYLE_MAP);
         context.putVar(CellData.CELL_STYLE_MAP, this.cellStyleMap);
         // TODO possible error: content of DATA_VAR is not saved & restored
         for (Object rowObject : dataCollection) {

diff --git a/jxls/src/main/java/org/jxls/functions/GroupSum.java b/jxls/src/main/java/org/jxls/functions/GroupSum.java
@@ -4,6 +4,7 @@
 import java.util.Map;
 
 import org.apache.commons.beanutils.PropertyUtils;
+import org.jxls.command.EachCommand;
 import org.jxls.common.Context;
 import org.jxls.common.JxlsException;
 import org.jxls.expression.ExpressionEvaluator;
@@ -86,7 +87,7 @@ public T sum(String fieldName, Iterable<Object> collection, String filter) {
         }
         ExpressionEvaluator expressionEvaluator = transformationConfig.getExpressionEvaluator();
         Summarizer<T> sum = sumBuilder.build();
-        Object oldValue = context.getRunVar(objectVarName);
+        Object oldValue = EachCommand.getRunVar(context, objectVarName);
         for (Object i : collection) {
             Object value = getValue(i, fieldName);
             context.putVar(objectVarName, i);

diff --git a/jxls/src/test/java/org/jxls/common/ContextTest.java b/jxls/src/test/java/org/jxls/common/ContextTest.java
@@ -4,7 +4,6 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
-import java.util.HashMap;
 import java.util.Map;
 
 import org.junit.Test;
@@ -45,15 +44,4 @@ public void testToString() {
         assertTrue(context.toString().contains("y=Abc"));
         assertTrue(context.toString().contains("x=1"));
     }
-
-    @Test
-    public void testCreateFromMap() {
-        Map<String, Object> map = new HashMap<String, Object>();
-        map.put("x", "Abc");
-        map.put("y", Integer.valueOf(10));
-        Context context = new Context(map);
-        map.clear();
-        assertEquals("Abc", context.getVar("x"));
-        assertEquals(Integer.valueOf(10), context.getVar("y"));
-    }
 }