From 9930e7099fc1c08623f9ad0fb4020926a41f03ef Mon Sep 17 00:00:00 2001
From: Yegor Kozlov <yegor@apache.org>
Date: Thu, 30 Jun 2011 15:54:04 +0000
Subject: [PATCH] added Workbook.getForceFormulaRecalculation as requested in
 Bug 51422

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1141585 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/poi/hssf/usermodel/HSSFWorkbook.java  | 12 ++++++++++++
 src/java/org/apache/poi/ss/usermodel/Sheet.java      |  2 +-
 src/java/org/apache/poi/ss/usermodel/Workbook.java   |  7 +++++++
 .../org/apache/poi/xssf/streaming/SXSSFWorkbook.java |  7 +++++++
 .../org/apache/poi/xssf/usermodel/XSSFWorkbook.java  | 12 ++++++++++++
 .../apache/poi/xssf/usermodel/TestXSSFWorkbook.java  |  4 ++++
 .../org/apache/poi/hssf/model/TestWorkbook.java      |  4 ++++
 7 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index 6b3348aa4..178bb37a4 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -1792,4 +1792,16 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
         recalc.setEngineId(0);
     }
 
+    /**
+     * Whether Excel will be asked to recalculate all formulas when the  workbook is opened.
+     *
+     * @since 3.8
+     */
+    public boolean getForceFormulaRecalculation(){
+        InternalWorkbook iwb = getWorkbook();
+        RecalcIdRecord recalc = (RecalcIdRecord)iwb.findFirstRecordBySid(RecalcIdRecord.sid);
+        return recalc != null && recalc.getEngineId() != 0;
+    }
+
+
 }
diff --git a/src/java/org/apache/poi/ss/usermodel/Sheet.java b/src/java/org/apache/poi/ss/usermodel/Sheet.java
index bb4810f50..b7c145c26 100644
--- a/src/java/org/apache/poi/ss/usermodel/Sheet.java
+++ b/src/java/org/apache/poi/ss/usermodel/Sheet.java
@@ -319,7 +319,7 @@ public interface Sheet extends Iterable<Row> {
     void setForceFormulaRecalculation(boolean value);
 
     /**
-     * Whether Excel will be asked to recalculate all formulas when the
+     * Whether Excel will be asked to recalculate all formulas in this sheet when the
      *  workbook is opened.  
      */
     boolean getForceFormulaRecalculation();
diff --git a/src/java/org/apache/poi/ss/usermodel/Workbook.java b/src/java/org/apache/poi/ss/usermodel/Workbook.java
index 6ca460168..3ee44fdc1 100644
--- a/src/java/org/apache/poi/ss/usermodel/Workbook.java
+++ b/src/java/org/apache/poi/ss/usermodel/Workbook.java
@@ -564,4 +564,11 @@ public interface Workbook {
      */
     public void setForceFormulaRecalculation(boolean value);
 
+    /**
+     * Whether Excel will be asked to recalculate all formulas when the  workbook is opened.
+     *
+     * @since 3.8
+     */
+    boolean getForceFormulaRecalculation();
+
 }
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
index 6ca1f51e6..6ba4137b5 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -835,5 +835,12 @@ public class SXSSFWorkbook implements Workbook
         _wb.setForceFormulaRecalculation(value);
     }
 
+    /**
+     * Whether Excel will be asked to recalculate all formulas when the  workbook is opened.
+     */
+    public boolean getForceFormulaRecalculation(){
+        return _wb.getForceFormulaRecalculation();
+    }
+
 //end of interface implementation
 }
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 95cbe7359..d8689d87a 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -1596,4 +1596,16 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
         // in the workbook the next time the file is opened.
         calcPr.setCalcId(0);
     }
+
+    /**
+     * Whether Excel will be asked to recalculate all formulas when the  workbook is opened.
+     *
+     * @since 3.8
+     */
+    public boolean getForceFormulaRecalculation(){
+        CTWorkbook ctWorkbook = getCTWorkbook();
+        CTCalcPr calcPr = ctWorkbook.getCalcPr();
+        return calcPr != null && calcPr.getCalcId() != 0;
+    }
+
 }
diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
index a4ab3bb71..5642f26f2 100644
--- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
+++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
@@ -410,6 +410,7 @@ public final class TestXSSFWorkbook extends BaseTestWorkbook {
 
     public void testRecalcId() {
         XSSFWorkbook wb = new XSSFWorkbook();
+        assertFalse(wb.getForceFormulaRecalculation());
         CTWorkbook ctWorkbook = wb.getCTWorkbook();
         assertFalse(ctWorkbook.isSetCalcPr());
 
@@ -420,8 +421,11 @@ public final class TestXSSFWorkbook extends BaseTestWorkbook {
         assertEquals(0, (int) calcPr.getCalcId());
 
         calcPr.setCalcId(100);
+        assertTrue(wb.getForceFormulaRecalculation());
+
         wb.setForceFormulaRecalculation(true); // resets the EngineId flag to zero
         assertEquals(0, (int) calcPr.getCalcId());
+        assertFalse(wb.getForceFormulaRecalculation());
     }
 
 }
diff --git a/src/testcases/org/apache/poi/hssf/model/TestWorkbook.java b/src/testcases/org/apache/poi/hssf/model/TestWorkbook.java
index 897fba1ae..d8aa165f5 100644
--- a/src/testcases/org/apache/poi/hssf/model/TestWorkbook.java
+++ b/src/testcases/org/apache/poi/hssf/model/TestWorkbook.java
@@ -119,6 +119,8 @@ public final class TestWorkbook extends TestCase {
 
     public void testRecalcId(){
         HSSFWorkbook wb = new HSSFWorkbook();
+        assertFalse(wb.getForceFormulaRecalculation());
+
         InternalWorkbook iwb = TestHSSFWorkbook.getInternalWorkbook(wb);
         int countryPos = iwb.findFirstRecordLocBySid(CountryRecord.sid);
         assertTrue(countryPos != -1);
@@ -133,8 +135,10 @@ public final class TestWorkbook extends TestCase {
 
         record.setEngineId(100);
         assertEquals(100, record.getEngineId());
+        assertTrue(wb.getForceFormulaRecalculation());
 
         wb.setForceFormulaRecalculation(true); // resets the EngineId flag to zero
         assertEquals(0, record.getEngineId());
+        assertFalse(wb.getForceFormulaRecalculation());
     }
 }