poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n...@apache.org
Subject svn commit: r1755070 - in /poi/trunk/src/java/org/apache/poi: hssf/usermodel/HSSFFormulaEvaluator.java ss/formula/BaseFormulaEvaluator.java
Date Wed, 03 Aug 2016 11:42:04 GMT
Author: nick
Date: Wed Aug  3 11:42:04 2016
New Revision: 1755070

URL: http://svn.apache.org/viewvc?rev=1755070&view=rev
Log:
Refactor out some of the common FormulaEvaluator logic from HSSF to a base class (XSSF coming
shortly)

Added:
    poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java   (with props)
Modified:
    poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java

Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java?rev=1755070&r1=1755069&r2=1755070&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java Wed Aug  3
11:42:04 2016
@@ -19,10 +19,10 @@ package org.apache.poi.hssf.usermodel;
 
 import java.util.Map;
 
+import org.apache.poi.ss.formula.BaseFormulaEvaluator;
 import org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment;
 import org.apache.poi.ss.formula.IStabilityClassifier;
 import org.apache.poi.ss.formula.WorkbookEvaluator;
-import org.apache.poi.ss.formula.WorkbookEvaluatorProvider;
 import org.apache.poi.ss.formula.eval.BoolEval;
 import org.apache.poi.ss.formula.eval.ErrorEval;
 import org.apache.poi.ss.formula.eval.NumericValueEval;
@@ -45,8 +45,7 @@ import org.apache.poi.util.Internal;
  * cell values.  Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells
are changed between
  * calls to evaluate~ methods on this class.
  */
-public class HSSFFormulaEvaluator implements FormulaEvaluator, WorkbookEvaluatorProvider
{
-    private final WorkbookEvaluator _bookEvaluator;
+public class HSSFFormulaEvaluator extends BaseFormulaEvaluator {
     private final HSSFWorkbook _book;
 
     public HSSFFormulaEvaluator(HSSFWorkbook workbook) {
@@ -70,8 +69,8 @@ public class HSSFFormulaEvaluator implem
      * @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
      */
     private HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier,
UDFFinder udfFinder) {
+        super(new WorkbookEvaluator(HSSFEvaluationWorkbook.create(workbook), stabilityClassifier,
udfFinder));
         _book = workbook;
-        _bookEvaluator = new WorkbookEvaluator(HSSFEvaluationWorkbook.create(workbook), stabilityClassifier,
udfFinder);
     }
 
     /**
@@ -94,11 +93,7 @@ public class HSSFFormulaEvaluator implem
      * @param evaluators all evaluators for the full set of workbooks required by the formulas.
      */
     public static void setupEnvironment(String[] workbookNames, HSSFFormulaEvaluator[] evaluators)
{
-        WorkbookEvaluator[] wbEvals = new WorkbookEvaluator[evaluators.length];
-        for (int i = 0; i < wbEvals.length; i++) {
-            wbEvals[i] = evaluators[i]._bookEvaluator;
-        }
-        CollaboratingWorkbooksEnvironment.setup(workbookNames, wbEvals);
+        BaseFormulaEvaluator.setupEnvironment(workbookNames, evaluators);
     }
 
     @Override
@@ -106,23 +101,6 @@ public class HSSFFormulaEvaluator implem
         CollaboratingWorkbooksEnvironment.setupFormulaEvaluator(evaluators);
     }
 
-    @Override
-    public WorkbookEvaluator _getWorkbookEvaluator() {
-        return _bookEvaluator;
-    }
-
-    /**
-     * Should be called whenever there are major changes (e.g. moving sheets) to input cells
-     * in the evaluated workbook.  If performance is not critical, a single call to this
method
-     * may be used instead of many specific calls to the notify~ methods.
-     *
-     * Failure to call this method after changing cell values will cause incorrect behaviour
-     * of the evaluate~ methods of this class
-     */
-    @Override
-    public void clearAllCachedResultValues() {
-        _bookEvaluator.clearAllCachedResultValues();
-    }
     /**
      * Should be called to tell the cell value cache that the specified (value or formula)
cell
      * has changed.
@@ -162,61 +140,6 @@ public class HSSFFormulaEvaluator implem
     }
 
     /**
-     * If cell contains a formula, the formula is evaluated and returned,
-     * else the CellValue simply copies the appropriate cell value from
-     * the cell and also its cell type. This method should be preferred over
-     * evaluateInCell() when the call should not modify the contents of the
-     * original cell.
-     *
-     * @param cell may be <code>null</code> signifying that the cell is not present
(or blank)
-     * @return <code>null</code> if the supplied cell is <code>null</code>
or blank
-     */
-    @Override
-    public CellValue evaluate(Cell cell) {
-        if (cell == null) {
-            return null;
-        }
-
-        switch (cell.getCellTypeEnum()) {
-            case BOOLEAN:
-                return CellValue.valueOf(cell.getBooleanCellValue());
-            case ERROR:
-                return CellValue.getError(cell.getErrorCellValue());
-            case FORMULA:
-                return evaluateFormulaCellValue(cell);
-            case NUMERIC:
-                return new CellValue(cell.getNumericCellValue());
-            case STRING:
-                return new CellValue(cell.getRichStringCellValue().getString());
-            case BLANK:
-                return null;
-            default:
-                throw new IllegalStateException("Bad cell type (" + cell.getCellTypeEnum()
+ ")");
-        }
-    }
-
-
-    /**
-     * If cell contains formula, it evaluates the formula, and saves the result of the formula.
The
-     * cell remains as a formula cell. If the cell does not contain formula, this method
returns -1
-     * and leaves the cell unchanged.
-     *
-     * Note that the type of the <em>formula result</em> is returned, so you
know what kind of
-     * cached formula result is also stored with  the formula.
-     * <pre>
-     * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
-     * </pre>
-     * Be aware that your cell will hold both the formula, and the result. If you want the
cell
-     * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
-     * @param cell The cell to evaluate
-     * @return -1 for non-formula cells, or the type of the <em>formula result</em>
-     */
-    @Override
-    public int evaluateFormulaCell(Cell cell) {
-        return evaluateFormulaCellEnum(cell).getCode();
-    }
-
-    /**
      * If cell contains formula, it evaluates the formula, and saves the result of the formula.
The
      * cell remains as a formula cell. If the cell does not contain formula, rather than
throwing an
      * exception, this method returns {@link CellType#_NONE} and leaves the cell unchanged.
@@ -273,23 +196,6 @@ public class HSSFFormulaEvaluator implem
         }
         return result;
     }
-    private static void setCellType(Cell cell, CellValue cv) {
-        CellType cellType = cv.getCellType();
-        switch (cellType) {
-            case BOOLEAN:
-            case ERROR:
-            case NUMERIC:
-            case STRING:
-                cell.setCellType(cellType);
-                return;
-            case BLANK:
-                // never happens - blanks eventually get translated to zero
-            case FORMULA:
-                // this will never happen, we have already evaluated the formula
-            default:
-                throw new IllegalStateException("Unexpected cell value type (" + cellType
+ ")");
-        }
-    }
 
     private static void setCellValue(Cell cell, CellValue cv) {
         CellType cellType = cv.getCellType();
@@ -379,7 +285,7 @@ public class HSSFFormulaEvaluator implem
      * Returns a CellValue wrapper around the supplied ValueEval instance.
      * @param cell
      */
-    private CellValue evaluateFormulaCellValue(Cell cell) {
+    protected CellValue evaluateFormulaCellValue(Cell cell) {
         ValueEval eval = _bookEvaluator.evaluate(new HSSFEvaluationCell((HSSFCell)cell));
         if (eval instanceof BoolEval) {
             BoolEval be = (BoolEval) eval;

Added: poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java?rev=1755070&view=auto
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java (added)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java Wed Aug  3 11:42:04
2016
@@ -0,0 +1,192 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.ss.formula;
+
+import java.util.Map;
+
+import org.apache.poi.ss.usermodel.Cell;
+import org.apache.poi.ss.usermodel.CellType;
+import org.apache.poi.ss.usermodel.CellValue;
+import org.apache.poi.ss.usermodel.FormulaEvaluator;
+import org.apache.poi.ss.usermodel.Row;
+import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.Workbook;
+
+/**
+ * Common functionality across file formats for evaluating formula cells.<p/>
+ */
+public abstract class BaseFormulaEvaluator implements FormulaEvaluator, WorkbookEvaluatorProvider
{
+    protected final WorkbookEvaluator _bookEvaluator;
+
+    protected BaseFormulaEvaluator(WorkbookEvaluator bookEvaluator) {
+        this._bookEvaluator = bookEvaluator;
+    }
+
+    /**
+     * Coordinates several formula evaluators together so that formulas that involve external
+     * references can be evaluated.
+     * @param workbookNames the simple file names used to identify the workbooks in formulas
+     * with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
+     * @param evaluators all evaluators for the full set of workbooks required by the formulas.
+     */
+    public static void setupEnvironment(String[] workbookNames, BaseFormulaEvaluator[] evaluators)
{
+        WorkbookEvaluator[] wbEvals = new WorkbookEvaluator[evaluators.length];
+        for (int i = 0; i < wbEvals.length; i++) {
+            wbEvals[i] = evaluators[i]._bookEvaluator;
+        }
+        CollaboratingWorkbooksEnvironment.setup(workbookNames, wbEvals);
+    }
+
+    @Override
+    public void setupReferencedWorkbooks(Map<String, FormulaEvaluator> evaluators)
{
+        CollaboratingWorkbooksEnvironment.setupFormulaEvaluator(evaluators);
+    }
+
+    @Override
+    public WorkbookEvaluator _getWorkbookEvaluator() {
+        return _bookEvaluator;
+    }
+
+    /**
+     * Should be called whenever there are major changes (e.g. moving sheets) to input cells
+     * in the evaluated workbook.  If performance is not critical, a single call to this
method
+     * may be used instead of many specific calls to the notify~ methods.
+     *
+     * Failure to call this method after changing cell values will cause incorrect behaviour
+     * of the evaluate~ methods of this class
+     */
+    @Override
+    public void clearAllCachedResultValues() {
+        _bookEvaluator.clearAllCachedResultValues();
+    }
+
+    /**
+     * If cell contains a formula, the formula is evaluated and returned,
+     * else the CellValue simply copies the appropriate cell value from
+     * the cell and also its cell type. This method should be preferred over
+     * evaluateInCell() when the call should not modify the contents of the
+     * original cell.
+     *
+     * @param cell may be <code>null</code> signifying that the cell is not present
(or blank)
+     * @return <code>null</code> if the supplied cell is <code>null</code>
or blank
+     */
+    @Override
+    public CellValue evaluate(Cell cell) {
+        if (cell == null) {
+            return null;
+        }
+
+        switch (cell.getCellTypeEnum()) {
+            case BOOLEAN:
+                return CellValue.valueOf(cell.getBooleanCellValue());
+            case ERROR:
+                return CellValue.getError(cell.getErrorCellValue());
+            case FORMULA:
+                return evaluateFormulaCellValue(cell);
+            case NUMERIC:
+                return new CellValue(cell.getNumericCellValue());
+            case STRING:
+                return new CellValue(cell.getRichStringCellValue().getString());
+            case BLANK:
+                return null;
+            default:
+                throw new IllegalStateException("Bad cell type (" + cell.getCellTypeEnum()
+ ")");
+        }
+    }
+
+    protected abstract CellValue evaluateFormulaCellValue(Cell cell);
+
+    /**
+     * If cell contains formula, it evaluates the formula, and saves the result of the formula.
The
+     * cell remains as a formula cell. If the cell does not contain formula, this method
returns -1
+     * and leaves the cell unchanged.
+     *
+     * Note that the type of the <em>formula result</em> is returned, so you
know what kind of
+     * cached formula result is also stored with  the formula.
+     * <pre>
+     * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
+     * </pre>
+     * Be aware that your cell will hold both the formula, and the result. If you want the
cell
+     * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
+     * @param cell The cell to evaluate
+     * @return -1 for non-formula cells, or the type of the <em>formula result</em>
+     */
+    @Override
+    public int evaluateFormulaCell(Cell cell) {
+        return evaluateFormulaCellEnum(cell).getCode();
+    }
+
+    protected static void setCellType(Cell cell, CellValue cv) {
+        CellType cellType = cv.getCellType();
+        switch (cellType) {
+            case BOOLEAN:
+            case ERROR:
+            case NUMERIC:
+            case STRING:
+                cell.setCellType(cellType);
+                return;
+            case BLANK:
+                // never happens - blanks eventually get translated to zero
+            case FORMULA:
+                // this will never happen, we have already evaluated the formula
+            default:
+                throw new IllegalStateException("Unexpected cell value type (" + cellType
+ ")");
+        }
+    }
+
+    /**
+     * Loops over all cells in all sheets of the supplied
+     *  workbook.
+     * For cells that contain formulas, their formulas are
+     *  evaluated, and the results are saved. These cells
+     *  remain as formula cells.
+     * For cells that do not contain formulas, no changes
+     *  are made.
+     * This is a helpful wrapper around looping over all
+     *  cells, and calling evaluateFormulaCell on each one.
+     */
+    public static void evaluateAllFormulaCells(Workbook wb) {
+        FormulaEvaluator evaluator = wb.getCreationHelper().createFormulaEvaluator();
+        evaluateAllFormulaCells(wb, evaluator);
+    }
+    private static void evaluateAllFormulaCells(Workbook wb, FormulaEvaluator evaluator)
{
+        for(int i=0; i<wb.getNumberOfSheets(); i++) {
+            Sheet sheet = wb.getSheetAt(i);
+
+            for(Row r : sheet) {
+                for (Cell c : r) {
+                    if (c.getCellTypeEnum() == CellType.FORMULA) {
+                        evaluator.evaluateFormulaCellEnum(c);
+                    }
+                }
+            }
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setIgnoreMissingWorkbooks(boolean ignore){
+        _bookEvaluator.setIgnoreMissingWorkbooks(ignore);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setDebugEvaluationOutputForNextEval(boolean value){
+        _bookEvaluator.setDebugEvaluationOutputForNextEval(value);
+    }
+}

Propchange: poi/trunk/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org


Mime
View raw message