Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html?rev=1755081&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/BaseFormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -0,0 +1,576 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>BaseFormulaEvaluator (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BaseFormulaEvaluator (POI API Documentation)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BaseFormulaEvaluator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/BaseFormulaEvaluator.html" target="_top">Frames</a></li> +<li><a href="BaseFormulaEvaluator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.poi.ss.formula</div> +<h2 title="Class BaseFormulaEvaluator" class="title">Class BaseFormulaEvaluator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.poi.ss.formula.BaseFormulaEvaluator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</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></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">BaseFormulaEvaluator</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> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</li> +</ul> +</div> +<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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/ss/formula/BaseFormulaEvaluator.html#_bookEvaluator">_bookEvaluator</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#BaseFormulaEvaluator(org.apache.poi.ss.formula.WorkbookEvaluator)">BaseFormulaEvaluator</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> bookEvaluator)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<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/ss/formula/BaseFormulaEvaluator.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/ss/formula/BaseFormulaEvaluator.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><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/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>static void</code></td> +<td class="colLast"><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="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><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> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><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"><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"><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> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.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="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.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="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#setupEnvironment(java.lang.String[],%20org.apache.poi.ss.formula.BaseFormulaEvaluator[])">setupEnvironment</a></strong>(java.lang.String[] workbookNames, + <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a>[] evaluators)</code> +<div class="block">Coordinates several formula evaluators together so that formulas that involve external + references can be evaluated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><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> +<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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ss.usermodel.FormulaEvaluator"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html" title="interface in org.apache.poi.ss.usermodel">FormulaEvaluator</a></h3> +<code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateAll()">evaluateAll</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateFormulaCellEnum(org.apache.poi.ss.usermodel.Cell)">evaluateFormulaCellEnum</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateInCell(org.apache.poi.ss.usermodel.Cell)">evaluateInCell</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifySetFormula(org.apache.poi.ss.usermodel.Cell)">notifySetFormula</a>, <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyUpdateCell(org.apache.poi.ss.usermodel.Cell)">notifyUpdateCell</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="_bookEvaluator"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>_bookEvaluator</h4> +<pre>protected final <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> _bookEvaluator</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BaseFormulaEvaluator(org.apache.poi.ss.formula.WorkbookEvaluator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BaseFormulaEvaluator</h4> +<pre>protected BaseFormulaEvaluator(<a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> bookEvaluator)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setupEnvironment(java.lang.String[], org.apache.poi.ss.formula.BaseFormulaEvaluator[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setupEnvironment</h4> +<pre>public static void setupEnvironment(java.lang.String[] workbookNames, + <a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a>[] evaluators)</pre> +<div class="block">Coordinates several formula evaluators together so that formulas that involve external + references can be evaluated.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workbookNames</code> - 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")</dd><dd><code>evaluators</code> - all evaluators for the full set of workbooks required by the formulas.</dd></dl> +</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="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. 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</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="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> - may be <code>null</code> signifying that the cell is not present (or blank)</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>null</code> if the supplied cell is <code>null</code> or blank</dd></dl> +</li> +</ul> +<a name="evaluateFormulaCellValue(org.apache.poi.ss.usermodel.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluateFormulaCellValue</h4> +<pre>protected abstract <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> +</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. 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 <a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateInCell(org.apache.poi.ss.usermodel.Cell)"><code>FormulaEvaluator.evaluateInCell(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>-1 for non-formula cells, or the type of the <em>formula result</em></dd></dl> +</li> +</ul> +<a name="setCellType(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.CellValue)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCellType</h4> +<pre>protected static void setCellType(<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)</pre> +</li> +</ul> +<a name="evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluateAllFormulaCells</h4> +<pre>public static void evaluateAllFormulaCells(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a> wb)</pre> +<div class="block">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.</div> +</li> +</ul> +<a name="evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook, org.apache.poi.ss.usermodel.FormulaEvaluator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluateAllFormulaCells</h4> +<pre>protected static void evaluateAllFormulaCells(<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)</pre> +</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> +<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> +<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> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BaseFormulaEvaluator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/poi/ss/formula/BaseFormulaEvaluator.html" target="_top">Frames</a></li> +<li><a href="BaseFormulaEvaluator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small> + <i>Copyright 2016 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html>
Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html Wed Aug 3 11:55:26 2016 @@ -34,7 +34,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> @@ -279,7 +279,7 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html" title="class in org.apache.poi.ss.formula"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluatorProvider.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/WorkbookEvaluatorProvider.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> Added: poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html?rev=1755081&view=auto ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html (added) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html Wed Aug 3 11:55:26 2016 @@ -0,0 +1,250 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<title>Uses of Class org.apache.poi.ss.formula.BaseFormulaEvaluator (POI API Documentation)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.poi.ss.formula.BaseFormulaEvaluator (POI API Documentation)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html" target="_top">Frames</a></li> +<li><a href="BaseFormulaEvaluator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.poi.ss.formula.BaseFormulaEvaluator" class="title">Uses of Class<br>org.apache.poi.ss.formula.BaseFormulaEvaluator</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> +<td class="colLast"> +<div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> +</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.xssf.streaming">org.apache.poi.xssf.streaming</a></td> +<td class="colLast"> </td> +</tr> +<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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.poi.hssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</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/hssf/usermodel/HSSFFormulaEvaluator.html" title="class in org.apache.poi.hssf.usermodel">HSSFFormulaEvaluator</a></strong></code> +<div class="block">Evaluates formula cells.<p/> + + For performance reasons, this class keeps a cache of all previously calculated intermediate + cell values.</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/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</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/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</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#setupEnvironment(java.lang.String[],%20org.apache.poi.ss.formula.BaseFormulaEvaluator[])">setupEnvironment</a></strong>(java.lang.String[] workbookNames, + <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a>[] evaluators)</code> +<div class="block">Coordinates several formula evaluators together so that formulas that involve external + references can be evaluated.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.xssf.streaming"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/xssf/streaming/package-summary.html">org.apache.poi.xssf.streaming</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/xssf/streaming/package-summary.html">org.apache.poi.xssf.streaming</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/xssf/streaming/SXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.streaming">SXSSFFormulaEvaluator</a></strong></code> +<div class="block">Streaming-specific Formula Evaluator, which is able to + lookup cells within the current Window.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.xssf.usermodel"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a> in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</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/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a></strong></code> +<div class="block">Internal POI use only - parent of XSSF and SXSSF formula evaluators</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">XSSFFormulaEvaluator</a></strong></code> +<div class="block">Evaluates formula cells.<p/> + + For performance reasons, this class keeps a cache of all previously calculated intermediate + cell values.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html" target="_top">Frames</a></li> +<li><a href="BaseFormulaEvaluator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small> + <i>Copyright 2016 The Apache Software Foundation or + its licensors, as applicable.</i> + </small></p> +</body> +</html> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html Wed Aug 3 11:55:26 2016 @@ -74,18 +74,12 @@ </tr> <tbody> <tr class="altColor"> -<td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> -<td class="colLast"> -<div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> -</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"> +<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> @@ -94,28 +88,23 @@ </li> <li class="blockList"> <ul class="blockList"> -<li class="blockList"><a name="org.apache.poi.hssf.usermodel"> +<li class="blockList"><a name="org.apache.poi.ss.formula"> <!-- --> </a> -<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> in <a href="../../../../../../org/apache/poi/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</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/hssf/usermodel/package-summary.html">org.apache.poi.hssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></span><span class="tabEnd"> </span></caption> +<h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</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 fields, and an explanation"> +<caption><span>Fields in <a href="../../../../../../org/apache/poi/ss/formula/package-summary.html">org.apache.poi.ss.formula</a> declared as <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</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> +<th class="colLast" scope="col">Field and Description</th> </tr> <tbody> <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"><span class="strong">HSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a></strong>()</code> </td> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></code></td> +<td class="colLast"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_bookEvaluator">_bookEvaluator</a></strong></code> </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/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</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/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></span><span class="tabEnd"> </span></caption> <tr> @@ -131,6 +120,10 @@ </tr> <tr class="rowColor"> <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"><span class="strong">BaseFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a></strong>()</code> </td> +</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"><span class="strong">CollaboratingWorkbooksEnvironment.</span><code><strong><a href="../../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html#getWorkbookEvaluator(java.lang.String)">getWorkbookEvaluator</a></strong>(java.lang.String workbookName)</code> </td> </tr> </tbody> @@ -169,6 +162,9 @@ </tr> <tbody> <tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html#BaseFormulaEvaluator(org.apache.poi.ss.formula.WorkbookEvaluator)">BaseFormulaEvaluator</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> bookEvaluator)</code> </td> +</tr> +<tr class="rowColor"> <td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/OperationEvaluationContext.html#OperationEvaluationContext(org.apache.poi.ss.formula.WorkbookEvaluator,%20org.apache.poi.ss.formula.EvaluationWorkbook,%20int,%20int,%20int,%20org.apache.poi.ss.formula.EvaluationTracker)">OperationEvaluationContext</a></strong>(<a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> bookEvaluator, <a href="../../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a> workbook, int sheetIndex, @@ -183,19 +179,6 @@ <!-- --> </a> <h3>Uses of <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</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/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> that return <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</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/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></code></td> -<td class="colLast"><span class="strong">BaseXSSFFormulaEvaluator.</span><code><strong><a href="../../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#_getWorkbookEvaluator()">_getWorkbookEvaluator</a></strong>()</code> </td> -</tr> -</tbody> -</table> <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> <caption><span>Constructors in <a href="../../../../../../org/apache/poi/xssf/usermodel/package-summary.html">org.apache.poi.xssf.usermodel</a> with parameters of type <a href="../../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></span><span class="tabEnd"> </span></caption> <tr> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.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.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> @@ -113,6 +119,26 @@ </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/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</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/formula/WorkbookEvaluatorProvider.html" title="interface in org.apache.poi.ss.formula">WorkbookEvaluatorProvider</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> </li> <li class="blockList"><a name="org.apache.poi.xssf.streaming"> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-frame.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-frame.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-frame.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-frame.html Wed Aug 3 11:55:26 2016 @@ -26,6 +26,7 @@ </ul> <h2 title="Classes">Classes</h2> <ul title="Classes"> +<li><a href="BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula" target="classFrame">BaseFormulaEvaluator</a></li> <li><a href="CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula" target="classFrame">CollaboratingWorkbooksEnvironment</a></li> <li><a href="EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula" target="classFrame">EvaluationWorkbook.ExternalName</a></li> <li><a href="EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula" target="classFrame">EvaluationWorkbook.ExternalSheet</a></li> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-summary.html Wed Aug 3 11:55:26 2016 @@ -183,37 +183,43 @@ </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/BaseFormulaEvaluator.html" title="class in org.apache.poi.ss.formula">BaseFormulaEvaluator</a></td> +<td class="colLast"> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula">CollaboratingWorkbooksEnvironment</a></td> <td class="colLast"> <div class="block">Manages a collection of <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>s, in order to support evaluation of formulas across spreadsheets.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheetRange.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheetRange</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/Formula.html" title="class in org.apache.poi.ss.formula">Formula</a></td> <td class="colLast"> <div class="block">Encapsulates an encoded formula token array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/FormulaParser.html" title="class in org.apache.poi.ss.formula">FormulaParser</a></td> <td class="colLast"> <div class="block">This class parses a formula string into a List of tokens in RPN order.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderer.html" title="class in org.apache.poi.ss.formula">FormulaRenderer</a></td> <td class="colLast"> <div class="block">Common logic for rendering formulas.<br/> @@ -221,23 +227,23 @@ For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/FormulaShifter.html" title="class in org.apache.poi.ss.formula">FormulaShifter</a></td> <td class="colLast"> <div class="block">Updates Formulas as rows or sheets are shifted</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/LazyRefEval.html" title="class in org.apache.poi.ss.formula">LazyRefEval</a></td> <td class="colLast"> <div class="block">Provides Lazy Evaluation to a 3D Reference</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/NameIdentifier.html" title="class in org.apache.poi.ss.formula">NameIdentifier</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/OperationEvaluationContext.html" title="class in org.apache.poi.ss.formula">OperationEvaluationContext</a></td> <td class="colLast"> <div class="block">Contains all the contextual information required to evaluate an operation @@ -246,27 +252,27 @@ For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/SharedFormula.html" title="class in org.apache.poi.ss.formula">SharedFormula</a></td> <td class="colLast"> <div class="block">Encapsulates logic to convert shared formulaa into non shared equivalent</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/SheetNameFormatter.html" title="class in org.apache.poi.ss.formula">SheetNameFormatter</a></td> <td class="colLast"> <div class="block">Formats sheet names for use in formula expressions.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/SheetRangeIdentifier.html" title="class in org.apache.poi.ss.formula">SheetRangeIdentifier</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a></td> <td class="colLast"> <div class="block">Evaluates formula cells.<p/> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-tree.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-tree.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-tree.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-tree.html Wed Aug 3 11:55:26 2016 @@ -72,6 +72,7 @@ <ul> <li type="circle">java.lang.Object <ul> +<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>)</li> <li type="circle">org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><span class="strong">CollaboratingWorkbooksEnvironment</span></a></li> <li type="circle">org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula"><span class="strong">EvaluationWorkbook.ExternalName</span></a></li> <li type="circle">org.apache.poi.ss.formula.<a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula"><span class="strong">EvaluationWorkbook.ExternalSheet</span></a> Modified: poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html?rev=1755081&r1=1755080&r2=1755081&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ss/formula/package-use.html Wed Aug 3 11:55:26 2016 @@ -247,68 +247,65 @@ </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html#org.apache.poi.hssf.usermodel">BaseFormulaEvaluator</a> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationCell.html#org.apache.poi.hssf.usermodel">EvaluationCell</a> <div class="block">Abstracts a cell for the purpose of formula evaluation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationName.html#org.apache.poi.hssf.usermodel">EvaluationName</a> <div class="block">Abstracts a name record for formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationSheet.html#org.apache.poi.hssf.usermodel">EvaluationSheet</a> <div class="block">Abstracts a sheet for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.html#org.apache.poi.hssf.usermodel">EvaluationWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalName.html#org.apache.poi.hssf.usermodel">EvaluationWorkbook.ExternalName</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalSheet.html#org.apache.poi.hssf.usermodel">EvaluationWorkbook.ExternalSheet</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParsingWorkbook.html#org.apache.poi.hssf.usermodel">FormulaParsingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula parsing.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaRenderingWorkbook.html#org.apache.poi.hssf.usermodel">FormulaRenderingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of converting formula to text.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/IStabilityClassifier.html#org.apache.poi.hssf.usermodel">IStabilityClassifier</a> <div class="block">Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are <em>final</em>.<br/> The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.</div> </td> </tr> -<tr class="rowColor"> -<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetIdentifier.html#org.apache.poi.hssf.usermodel">SheetIdentifier</a> </td> -</tr> <tr class="altColor"> -<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html#org.apache.poi.hssf.usermodel">WorkbookEvaluator</a> -<div class="block">Evaluates formula cells.<p/> - - For performance reasons, this class keeps a cache of all previously calculated intermediate - cell values.</div> -</td> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetIdentifier.html#org.apache.poi.hssf.usermodel">SheetIdentifier</a> </td> </tr> <tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html#org.apache.poi.hssf.usermodel">WorkbookEvaluatorProvider</a> @@ -346,98 +343,103 @@ </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html#org.apache.poi.ss.formula">BaseFormulaEvaluator</a> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/CollaboratingWorkbooksEnvironment.html#org.apache.poi.ss.formula">CollaboratingWorkbooksEnvironment</a> <div class="block">Manages a collection of <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>s, in order to support evaluation of formulas across spreadsheets.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/CollaboratingWorkbooksEnvironment.WorkbookNotFoundException.html#org.apache.poi.ss.formula">CollaboratingWorkbooksEnvironment.WorkbookNotFoundException</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationCell.html#org.apache.poi.ss.formula">EvaluationCell</a> <div class="block">Abstracts a cell for the purpose of formula evaluation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationName.html#org.apache.poi.ss.formula">EvaluationName</a> <div class="block">Abstracts a name record for formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationSheet.html#org.apache.poi.ss.formula">EvaluationSheet</a> <div class="block">Abstracts a sheet for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.html#org.apache.poi.ss.formula">EvaluationWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalName.html#org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalSheet.html#org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/Formula.html#org.apache.poi.ss.formula">Formula</a> <div class="block">Encapsulates an encoded formula token array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParsingWorkbook.html#org.apache.poi.ss.formula">FormulaParsingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula parsing.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaRenderingWorkbook.html#org.apache.poi.ss.formula">FormulaRenderingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of converting formula to text.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaShifter.html#org.apache.poi.ss.formula">FormulaShifter</a> <div class="block">Updates Formulas as rows or sheets are shifted</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaType.html#org.apache.poi.ss.formula">FormulaType</a> <div class="block">Enumeration of various formula types.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/IStabilityClassifier.html#org.apache.poi.ss.formula">IStabilityClassifier</a> <div class="block">Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are <em>final</em>.<br/> The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/NameIdentifier.html#org.apache.poi.ss.formula">NameIdentifier</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetIdentifier.html#org.apache.poi.ss.formula">SheetIdentifier</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetRange.html#org.apache.poi.ss.formula">SheetRange</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/TwoDEval.html#org.apache.poi.ss.formula">TwoDEval</a> <div class="block">Common interface of <a href="../../../../../org/apache/poi/ss/formula/eval/AreaEval.html" title="interface in org.apache.poi.ss.formula.eval"><code>AreaEval</code></a> and <a href="../../../../../org/apache/poi/ss/formula/eval/AreaEvalBase.html" title="class in org.apache.poi.ss.formula.eval"><code>AreaEvalBase</code></a>, for 2D (row+column) evaluations</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html#org.apache.poi.ss.formula">WorkbookEvaluator</a> <div class="block">Evaluates formula cells.<p/> @@ -445,6 +447,12 @@ cell values.</div> </td> </tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html#org.apache.poi.ss.formula">WorkbookEvaluatorProvider</a> +<div class="block">Provides access to a <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>, eg for use with + <a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><code>CollaboratingWorkbooksEnvironment</code></a></div> +</td> +</tr> </tbody> </table> </li> @@ -601,52 +609,57 @@ </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html#org.apache.poi.xssf.streaming">BaseFormulaEvaluator</a> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationCell.html#org.apache.poi.xssf.streaming">EvaluationCell</a> <div class="block">Abstracts a cell for the purpose of formula evaluation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationSheet.html#org.apache.poi.xssf.streaming">EvaluationSheet</a> <div class="block">Abstracts a sheet for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.html#org.apache.poi.xssf.streaming">EvaluationWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParseException.html#org.apache.poi.xssf.streaming">FormulaParseException</a> <div class="block">This exception thrown when a supplied formula has incorrect syntax (or syntax currently not supported by POI).</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParsingWorkbook.html#org.apache.poi.xssf.streaming">FormulaParsingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula parsing.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaRenderingWorkbook.html#org.apache.poi.xssf.streaming">FormulaRenderingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of converting formula to text.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/IStabilityClassifier.html#org.apache.poi.xssf.streaming">IStabilityClassifier</a> <div class="block">Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are <em>final</em>.<br/> The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html#org.apache.poi.xssf.streaming">WorkbookEvaluatorProvider</a> <div class="block">Provides access to a <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>, eg for use with <a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><code>CollaboratingWorkbooksEnvironment</code></a></div> @@ -665,62 +678,67 @@ </tr> <tbody> <tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/BaseFormulaEvaluator.html#org.apache.poi.xssf.usermodel">BaseFormulaEvaluator</a> +<div class="block">Common functionality across file formats for evaluating formula cells.<p/></div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationCell.html#org.apache.poi.xssf.usermodel">EvaluationCell</a> <div class="block">Abstracts a cell for the purpose of formula evaluation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationName.html#org.apache.poi.xssf.usermodel">EvaluationName</a> <div class="block">Abstracts a name record for formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationSheet.html#org.apache.poi.xssf.usermodel">EvaluationSheet</a> <div class="block">Abstracts a sheet for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.html#org.apache.poi.xssf.usermodel">EvaluationWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula evaluation.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalName.html#org.apache.poi.xssf.usermodel">EvaluationWorkbook.ExternalName</a> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/EvaluationWorkbook.ExternalSheet.html#org.apache.poi.xssf.usermodel">EvaluationWorkbook.ExternalSheet</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaParsingWorkbook.html#org.apache.poi.xssf.usermodel">FormulaParsingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of formula parsing.<br/> For POI internal use only</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/FormulaRenderingWorkbook.html#org.apache.poi.xssf.usermodel">FormulaRenderingWorkbook</a> <div class="block">Abstracts a workbook for the purpose of converting formula to text.<br/> For POI internal use only</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/IStabilityClassifier.html#org.apache.poi.xssf.usermodel">IStabilityClassifier</a> <div class="block">Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are <em>final</em>.<br/> The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/SheetIdentifier.html#org.apache.poi.xssf.usermodel">SheetIdentifier</a> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluator.html#org.apache.poi.xssf.usermodel">WorkbookEvaluator</a> <div class="block">Evaluates formula cells.<p/> @@ -728,7 +746,7 @@ cell values.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/poi/ss/formula/class-use/WorkbookEvaluatorProvider.html#org.apache.poi.xssf.usermodel">WorkbookEvaluatorProvider</a> <div class="block">Provides access to a <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula"><code>WorkbookEvaluator</code></a>, eg for use with <a href="../../../../../org/apache/poi/ss/formula/CollaboratingWorkbooksEnvironment.html" title="class in org.apache.poi.ss.formula"><code>CollaboratingWorkbooksEnvironment</code></a></div> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
