Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -86,7 +86,7 @@ <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html" title="class in org.apache.poi.hssf.usermodel">HSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.streaming">SXSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">XSSFFormulaEvaluator</a></dd> +<dd><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html" title="class in org.apache.poi.hssf.usermodel">HSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.streaming">SXSSFFormulaEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">XSSFFormulaEvaluator</a></dd> </dl> <hr> <br>
Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Cell.html Wed Aug 3 11:55:26 2016 @@ -86,22 +86,28 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.formula">org.apache.poi.ss.formula</a></td> +<td class="colLast"> +<div class="block">This package contains common internal POI code for manipulating formulas.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util">org.apache.poi.ss.util</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util.cellwalk">org.apache.poi.ss.util.cellwalk</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.streaming">org.apache.poi.xssf.streaming</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> <td class="colLast"> </td> </tr> @@ -157,20 +163,6 @@ </tr> <tbody> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> -<td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">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.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula.</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block"><strong>Deprecated.</strong> @@ -179,6 +171,12 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFCell.html" title="class in org.apache.poi.hssf.usermodel">HSSFCell</a></code></td> <td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluateInCell(org.apache.poi.ss.usermodel.Cell)">evaluateInCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">If cell contains formula, it evaluates the formula, and @@ -186,26 +184,26 @@ of the old formula.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Should be called to tell the cell value cache that the specified (value or formula) cell has changed.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellRange.html" title="interface in org.apache.poi.ss.usermodel">CellRange</a><<a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFCell.html" title="class in org.apache.poi.hssf.usermodel">HSSFCell</a>></code></td> <td class="colLast"><span class="strong">HSSFSheet.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#removeArrayFormula(org.apache.poi.ss.usermodel.Cell)">removeArrayFormula</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">HSSFRow.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFRow.html#removeCell(org.apache.poi.ss.usermodel.Cell)">removeCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">remove the HSSFCell from this row.</div> @@ -258,6 +256,43 @@ </tbody> </table> </li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">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.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">If cell contains formula, it evaluates the formula, and saves the result of the formula.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setCellType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellValue)">setCellType</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> cv)</code> </td> +</tr> +</tbody> +</table> +</li> <li class="blockList"><a name="org.apache.poi.ss.usermodel"> <!-- --> </a> @@ -885,21 +920,6 @@ </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> -<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">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.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">If cell contains formula, it evaluates the formula, - and saves the result of the formula.</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block"><strong>Deprecated.</strong> @@ -908,6 +928,12 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a></code></td> <td class="colLast"><span class="strong">XSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#evaluateInCell(org.apache.poi.ss.usermodel.Cell)">evaluateInCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">If cell contains formula, it evaluates the formula, and @@ -915,35 +941,35 @@ of the old formula.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellRange.html" title="interface in org.apache.poi.ss.usermodel">CellRange</a><<a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a>></code></td> <td class="colLast"><span class="strong">XSSFSheet.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#removeArrayFormula(org.apache.poi.ss.usermodel.Cell)">removeArrayFormula</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">XSSFRow.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFRow.html#removeCell(org.apache.poi.ss.usermodel.Cell)">removeCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Remove the Cell from this row.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a></code></td> <td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#toEvaluationCell(org.apache.poi.ss.usermodel.Cell)">toEvaluationCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a></code></td> <td class="colLast"><span class="strong">XSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#toEvaluationCell(org.apache.poi.ss.usermodel.Cell)">toEvaluationCell</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Turns a XSSFCell into a XSSFEvaluationCell</div> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellValue.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellValue.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellValue.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/CellValue.html Wed Aug 3 11:55:26 2016 @@ -80,10 +80,16 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.formula">org.apache.poi.ss.formula</a></td> +<td class="colLast"> +<div class="block">This package contains common internal POI code for manipulating formulas.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> <td class="colLast"> </td> </tr> @@ -104,13 +110,51 @@ </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> that return <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> -<td class="colLast"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">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.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setCellType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellValue)">setCellType</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell, + <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> cv)</code> </td> +</tr> </tbody> </table> </li> @@ -173,11 +217,9 @@ </tr> <tbody> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> -<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">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.</div> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> </td> </tr> </tbody> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -142,6 +142,35 @@ <!-- --> </a> <h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> that implement <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></strong></code> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.usermodel.FormulaEvaluator)">evaluateAllFormulaCells</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb, + <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator)</code> </td> +</tr> +</tbody> +</table> <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> <caption><span>Method parameters in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with type arguments of type <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></span><span class="tabEnd"> </span></caption> <tr> @@ -153,6 +182,10 @@ <td class="colFirst"><code>static void</code></td> <td class="colLast"><span class="strong">CollaboratingWorkbooksEnvironment.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html#setupFormulaEvaluator(java.util.Map)">setupFormulaEvaluator</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>> evaluators)</code> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>> evaluators)</code> </td> +</tr> </tbody> </table> </li> @@ -259,19 +292,6 @@ </tr> </tbody> </table> -<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> -<caption><span>Method parameters in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> with type arguments of type <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>> evaluators)</code> </td> -</tr> -</tbody> -</table> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Workbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Workbook.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Workbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/class-use/Workbook.html Wed Aug 3 11:55:26 2016 @@ -86,22 +86,28 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.ss.formula">org.apache.poi.ss.formula</a></td> +<td class="colLast"> +<div class="block">This package contains common internal POI code for manipulating formulas.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.formula.eval.forked">org.apache.poi.ss.formula.eval.forked</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.ss.usermodel">org.apache.poi.ss.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.ss.util">org.apache.poi.ss.util</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.streaming">org.apache.poi.xssf.streaming</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel</a></td> <td class="colLast"> </td> </tr> @@ -185,6 +191,32 @@ </tr> </tbody> </table> +</li> +<li class="blockList"><a name="org.apache.poi.ss.formula"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook)">evaluateAllFormulaCells</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb)</code> +<div class="block">Loops over all cells in all sheets of the supplied + workbook.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.usermodel.FormulaEvaluator)">evaluateAllFormulaCells</a></strong>(<a href="../../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb, + <a href="../../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a> evaluator)</code> </td> +</tr> +</tbody> +</table> </li> <li class="blockList"><a name="org.apache.poi.ss.formula.eval.forked"> <!-- --> Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-use.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/package-use.html Wed Aug 3 11:55:26 2016 @@ -649,8 +649,18 @@ HSSF concepts.</div> </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/usermodel/class-use/Cell.html#org.apache.poi.ss.formula">Cell</a> +<div class="block">High level representation of a cell in a row of a spreadsheet.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/usermodel/class-use/CellType.html#org.apache.poi.ss.formula">CellType</a> </td> </tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/usermodel/class-use/CellValue.html#org.apache.poi.ss.formula">CellValue</a> +<div class="block">Mimics the 'data view' of a cell.</div> +</td> +</tr> <tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/usermodel/class-use/FormulaEvaluator.html#org.apache.poi.ss.formula">FormulaEvaluator</a> <div class="block">Evaluates formula cells.<p/> @@ -670,6 +680,11 @@ HSSF concepts.</div> High level abstraction of table in a workbook.</div> </td> </tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/usermodel/class-use/Workbook.html#org.apache.poi.ss.formula">Workbook</a> +<div class="block">High level representation of a Excel workbook.</div> +</td> +</tr> </tbody> </table> </li> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -60,7 +60,7 @@ <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> @@ -85,6 +85,9 @@ <li>java.lang.Object</li> <li> <ul class="inheritance"> +<li><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">org.apache.poi.ss.formula.BaseFormulaEvaluator</a></li> +<li> +<ul class="inheritance"> <li><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel.BaseXSSFFormulaEvaluator</a></li> <li> <ul class="inheritance"> @@ -94,6 +97,8 @@ </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> @@ -136,6 +141,21 @@ extends <a href="../../../../../org/apac </table> </li> </ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></h3> +<code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_bookEvaluator">_bookEvaluator</a></code></li> +</ul> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> @@ -205,7 +225,14 @@ extends <a href="../../../../../org/apac <!-- --> </a> <h3>Methods inherited from class org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a></h3> -<code><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#doEvaluateInCell(org.apache.poi.ss.usermodel.Cell)">doEvaluateInCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEval uator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setDebugEvaluationOutputForNextEval(boolean)">setDebugEvaluationOutputForNextEval</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></code></li> +<code><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#doEvaluateInCell(org.apache.poi.ss.usermodel.Cell)">doEvaluateInCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></h3> +<code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook)">evaluateAllFormulaCells</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.usermodel.FormulaEvaluator)">evaluateAllFormulaCells</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a>, <a href="../../../../../org/apache/poi/ss/formula/B aseFormulaEvaluator.html#setCellType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellValue)">setCellType</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setDebugEvaluationOutputForNextEval(boolean)">setDebugEvaluationOutputForNextEval</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupEnvironment(java.lang.String[],%20org.apache.poi.ss.formula.BaseFormulaEvaluator[])">setupEnvironment</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -375,7 +402,7 @@ extends <a href="../../../../../org/apac <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/streaming/package-tree.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/streaming/package-tree.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/streaming/package-tree.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/streaming/package-tree.html Wed Aug 3 11:55:26 2016 @@ -72,14 +72,18 @@ <ul> <li type="circle">java.lang.Object <ul> -<li type="circle">org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">BaseXSSFEvaluationWorkbook</span></a> (implements org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a>) +<li type="circle">org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">BaseFormulaEvaluator</span></a> (implements org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a>) <ul> -<li type="circle">org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">SXSSFEvaluationWorkbook</span></a></li> +<li type="circle">org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">BaseXSSFFormulaEvaluator</span></a> +<ul> +<li type="circle">org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">SXSSFFormulaEvaluator</span></a></li> </ul> </li> -<li type="circle">org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">BaseXSSFFormulaEvaluator</span></a> (implements org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a>) +</ul> +</li> +<li type="circle">org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">BaseXSSFEvaluationWorkbook</span></a> (implements org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a>, org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a>) <ul> -<li type="circle">org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">SXSSFFormulaEvaluator</span></a></li> +<li type="circle">org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">SXSSFEvaluationWorkbook</span></a></li> </ul> </li> <li type="circle">org.apache.poi.xssf.streaming.<a href="../../../../../org/apache/poi/xssf/streaming/SheetDataWriter.html" title="class in org.apache.poi.xssf.streaming"><span class="strong">SheetDataWriter</span></a> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -60,7 +60,7 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> @@ -85,10 +85,15 @@ <li>java.lang.Object</li> <li> <ul class="inheritance"> +<li><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">org.apache.poi.ss.formula.BaseFormulaEvaluator</a></li> +<li> +<ul class="inheritance"> <li>org.apache.poi.xssf.usermodel.BaseXSSFFormulaEvaluator</li> </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> @@ -103,8 +108,7 @@ <hr> <br> <pre>public abstract class <span class="strong">BaseXSSFFormulaEvaluator</span> -extends java.lang.Object -implements <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>, <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a></pre> +extends <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></pre> <div class="block">Internal POI use only - parent of XSSF and SXSSF formula evaluators</div> </li> </ul> @@ -112,6 +116,21 @@ implements <a href="../../../../../org/a <div class="summary"> <ul class="blockList"> <li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></h3> +<code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_bookEvaluator">_bookEvaluator</a></code></li> +</ul> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> @@ -144,18 +163,6 @@ implements <a href="../../../../../org/a <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a></strong>()</code> -<div class="block">Provide the underlying WorkbookEvaluator</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a></strong>()</code> -<div class="block">Should be called whenever there are major changes (e.g.</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#doEvaluateInCell(org.apache.poi.ss.usermodel.Cell)">doEvaluateInCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">If cell contains formula, it evaluates the formula, and @@ -164,21 +171,6 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">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.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> -<div class="block">If cell contains formula, it evaluates the formula, - and saves the result of the formula.</div> -</td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/CellType.html" title="enum in org.apache.poi.ss.usermodel">CellType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block"><strong>Deprecated.</strong> @@ -187,47 +179,32 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Should be called to tell the cell value cache that the specified cell has just become a formula cell, or the formula text has changed</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Should be called to tell the cell value cache that the specified (value or formula) cell has changed.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> <div class="block">Should be called to tell the cell value cache that the specified (value or formula) cell has changed.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setDebugEvaluationOutputForNextEval(boolean)">setDebugEvaluationOutputForNextEval</a></strong>(boolean value)</code> -<div class="block">Perform detailed output of formula evaluation for next evaluation only? - Is for developer use only (also developers using POI for their XLS files).</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks</a></strong>(boolean ignore)</code> -<div class="block">Whether to ignore missing references to external workbooks and - use cached formula results in the main workbook instead.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>> evaluators)</code> -<div class="block">Sets up the Formula Evaluator to be able to reference and resolve - links to other workbooks, eg [Test.xls]Sheet1!A1.</div> -</td> -</tr> <tr class="altColor"> <td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#toEvaluationCell(org.apache.poi.ss.usermodel.Cell)">toEvaluationCell</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</code> @@ -236,6 +213,13 @@ implements <a href="../../../../../org/a </tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></h3> +<code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook)">evaluateAllFormulaCells</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook,%20org.apache.poi.ss.usermodel.FormulaEvaluator)">evaluateAllFormulaCells</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a>, <a href="../../../../../org/apache/poi/ss/formula/B aseFormulaEvaluator.html#setCellType(org.apache.poi.ss.usermodel.Cell,%20org.apache.poi.ss.usermodel.CellValue)">setCellType</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setDebugEvaluationOutputForNextEval(boolean)">setDebugEvaluationOutputForNextEval</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupEnvironment(java.lang.String[],%20org.apache.poi.ss.formula.BaseFormulaEvaluator[])">setupEnvironment</a>, <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></code></li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> @@ -280,23 +264,6 @@ implements <a href="../../../../../org/a <!-- --> </a> <h3>Method Detail</h3> -<a name="clearAllCachedResultValues()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>clearAllCachedResultValues</h4> -<pre>public void clearAllCachedResultValues()</pre> -<div class="block">Should be called whenever there are major changes (e.g. moving sheets) to input cells - in the evaluated workbook. - Failure to call this method after changing cell values will cause incorrect behaviour - of the evaluate~ methods of this class</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#clearAllCachedResultValues()">clearAllCachedResultValues</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -</dl> -</li> -</ul> <a name="notifySetFormula(org.apache.poi.ss.usermodel.Cell)"> <!-- --> </a> @@ -309,10 +276,6 @@ implements <a href="../../../../../org/a has changed. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -</dl> </li> </ul> <a name="notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)"> @@ -325,10 +288,6 @@ implements <a href="../../../../../org/a <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">FormulaEvaluator</a></code></strong></div> <div class="block">Should be called to tell the cell value cache that the specified cell has just become a formula cell, or the formula text has changed</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -</dl> </li> </ul> <a name="notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)"> @@ -343,56 +302,6 @@ implements <a href="../../../../../org/a has changed. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -</dl> -</li> -</ul> -<a name="evaluate(org.apache.poi.ss.usermodel.Cell)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>evaluate</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> evaluate(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block">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.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)">evaluate</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd></dl> -</li> -</ul> -<a name="evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>evaluateFormulaCell</h4> -<pre>public int evaluateFormulaCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block">If cell contains formula, it evaluates the formula, - and saves the result of the formula. The cell - remains as a formula cell. - Else if cell does not contain formula, this method leaves - the cell unchanged. - Note that the type of the formula result is returned, - so you know what kind of value 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 <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)"><code>evaluate(org.apache.poi.ss.usermodel.Cell)</code></a> }</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCell</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - The cell to evaluate</dd> -<dt><span class="strong">Returns:</span></dt><dd>The type of the formula result (the cell's type remains as CellType.FORMULA however)</dd></dl> </li> </ul> <a name="evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)"> @@ -417,11 +326,8 @@ public <a href="../../../../../org/ </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 <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)"><code>evaluate(org.apache.poi.ss.usermodel.Cell)</code></a> }</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - The cell to evaluate</dd> + the result of the formula, use <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluate(org.apache.poi.ss.usermodel.Cell)"><code>BaseFormulaEvaluator.evaluate(org.apache.poi.ss.usermodel.Cell)</code></a> }</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - The cell to evaluate</dd> <dt><span class="strong">Returns:</span></dt><dd>The type of the formula result (the cell's type remains as CellType.FORMULA however) If cell is not a formula cell, returns <a href="../../../../../org/apache/poi/ss/usermodel/CellType.html#_NONE"><code>CellType._NONE</code></a> rather than throwing an exception.</dd><dt><span class="strong">Since:</span></dt> <dd>POI 3.15 beta 3</dd></dl> @@ -451,80 +357,18 @@ public <a href="../../../../../org/ <div class="block">Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell</div> </li> </ul> -<a name="setupReferencedWorkbooks(java.util.Map)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setupReferencedWorkbooks</h4> -<pre>public void setupReferencedWorkbooks(java.util.Map<java.lang.String,<a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a>> evaluators)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">FormulaEvaluator</a></code></strong></div> -<div class="block">Sets up the Formula Evaluator to be able to reference and resolve - links to other workbooks, eg [Test.xls]Sheet1!A1. - <p>For a workbook referenced as [Test.xls]Sheet1!A1, you should - supply a map containing the key Test.xls (no square brackets), - and an open FormulaEvaluator onto that Workbook.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>evaluators</code> - Map of workbook names (no square brackets) to an evaluator on that workbook</dd></dl> -</li> -</ul> -<a name="_getWorkbookEvaluator()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>_getWorkbookEvaluator</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> _getWorkbookEvaluator()</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html#_getWorkbookEvaluator()">WorkbookEvaluatorProvider</a></code></strong></div> -<div class="block">Provide the underlying WorkbookEvaluator</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a></code></dd> -</dl> -</li> -</ul> -<a name="setIgnoreMissingWorkbooks(boolean)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setIgnoreMissingWorkbooks</h4> -<pre>public void setIgnoreMissingWorkbooks(boolean ignore)</pre> -<div class="block">Whether to ignore missing references to external workbooks and - use cached formula results in the main workbook instead. - <p> - In some cases external workbooks referenced by formulas in the main workbook are not available. - With this method you can control how POI handles such missing references: - <ul> - <li>by default ignoreMissingWorkbooks=false and POI throws - <a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" title="class in org.apache.poi.ss.formula"><code>CollaboratingWorkbooksEnvironment.WorkbookNotFoundException</code></a> - if an external reference cannot be resolved</li> - <li>if ignoreMissingWorkbooks=true then POI uses cached formula result - that already exists in the main workbook</li> - </ul></div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>ignore</code> - whether to ignore missing references to external workbooks</dd></dl> -</li> -</ul> -<a name="setDebugEvaluationOutputForNextEval(boolean)"> +<a name="evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>setDebugEvaluationOutputForNextEval</h4> -<pre>public void setDebugEvaluationOutputForNextEval(boolean value)</pre> -<div class="block">Perform detailed output of formula evaluation for next evaluation only? - Is for developer use only (also developers using POI for their XLS files). - Log-Level WARN is for basic info, INFO for detailed information. These quite - high levels are used because you have to explicitly enable this specific logging.</div> +<h4>evaluateFormulaCellValue</h4> +<pre>protected <a href="../../../../../org/apache/poi/ss/usermodel/CellValue.html" title="class in org.apache.poi.ss.usermodel">CellValue</a> evaluateFormulaCellValue(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block">Returns a CellValue wrapper around the supplied ValueEval instance.</div> <dl> <dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#setDebugEvaluationOutputForNextEval(boolean)">setDebugEvaluationOutputForNextEval</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - whether to perform detailed output</dd></dl> +<dd><code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellValue</a></code> in class <code><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></code></dd> +</dl> </li> </ul> </li> @@ -579,7 +423,7 @@ public <a href="../../../../../org/ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.ss.formula.BaseFormulaEvaluator">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
