Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html?rev=1693667&r1=1693666&r2=1693667&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html Fri Jul 31 23:09:47 2015 @@ -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.xssf.usermodel.BaseXSSFEvaluationWorkbook">Field</a> | </li> <li>Constr | </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/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">org.apache.poi.xssf.usermodel.BaseXSSFEvaluationWorkbook</a></li> +<li> +<ul class="inheritance"> <li>org.apache.poi.xssf.usermodel.XSSFEvaluationWorkbook</li> </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> @@ -99,8 +104,7 @@ <hr> <br> <pre>public final class <span class="strong">XSSFEvaluationWorkbook</span> -extends java.lang.Object -implements <a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a>, <a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a>, <a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></pre> +extends <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFEvaluationWorkbook</a></pre> <div class="block">Internal POI use only</div> </li> </ul> @@ -123,6 +127,21 @@ implements <a href="../../../../../org/a </ul> </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.xssf.usermodel.BaseXSSFEvaluationWorkbook"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFEvaluationWorkbook</a></h3> +<code><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#_uBook">_uBook</a></code></li> +</ul> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> @@ -136,139 +155,30 @@ implements <a href="../../../../../org/a <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#convertFromExternSheetIndex(int)">convertFromExternSheetIndex</a></strong>(int externSheetIndex)</code> -<div class="block">XSSF doesn't use external sheet indexes, so when asked treat - it just as a local index</div> -</td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFEvaluationWorkbook</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#create(org.apache.poi.xssf.usermodel.XSSFWorkbook)">create</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> book)</code> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.AreaReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a></strong>(<a href="../../../../../org/apache/poi/ss/util/AreaReference.html" title="class in org.apache.poi.ss.util">AreaReference</a> area, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</code> -<div class="block">Produce the appropriate Ptg for a 3d area reference</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a></strong>(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</code> -<div class="block">Produce the appropriate Ptg for a 3d cell reference</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getExternalName(int,%20int)">getExternalName</a></strong>(int externSheetIndex, - int externNameIndex)</code> -<div class="block">HSSF Only - fetch the external-style name details</div> -</td> -</tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getExternalName(java.lang.String,%20java.lang.String,%20int)">getExternalName</a></strong>(java.lang.String nameName, - java.lang.String sheetName, - int externalWorkbookNumber)</code> -<div class="block">XSSF Only - fetch the external-style name details</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getExternalSheet(int)">getExternalSheet</a></strong>(int externSheetIndex)</code> -<div class="block">HSSF Only - fetch the external-style sheet details</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getExternalSheet(java.lang.String,%20java.lang.String,%20int)">getExternalSheet</a></strong>(java.lang.String firstSheetName, - java.lang.String lastSheetName, - int externalWorkbookNumber)</code> -<div class="block">XSSF Only - fetch the external-style sheet details</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/XSSFEvaluationWorkbook.html#getExternalSheetIndex(java.lang.String)">getExternalSheetIndex</a></strong>(java.lang.String sheetName)</code> -<div class="block">gets the externSheet index for a sheet from this workbook</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getExternalSheetIndex(java.lang.String,%20java.lang.String)">getExternalSheetIndex</a></strong>(java.lang.String workbookName, - java.lang.String sheetName)</code> -<div class="block">gets the externSheet index for a sheet from an external workbook</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getFormulaTokens(org.apache.poi.ss.formula.EvaluationCell)">getFormulaTokens</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a> evalCell)</code> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationName.html" title="interface in org.apache.poi.ss.formula">EvaluationName</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getName(org.apache.poi.ss.formula.ptg.NamePtg)">getName</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/ptg/NamePtg.html" title="class in org.apache.poi.ss.formula.ptg">NamePtg</a> namePtg)</code> </td> -</tr> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationName.html" title="interface in org.apache.poi.ss.formula">EvaluationName</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getName(java.lang.String,%20int)">getName</a></strong>(java.lang.String name, - int sheetIndex)</code> -<div class="block">named range name matching is case insensitive</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getNameText(org.apache.poi.ss.formula.ptg.NamePtg)">getNameText</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/ptg/NamePtg.html" title="class in org.apache.poi.ss.formula.ptg">NamePtg</a> namePtg)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPxg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPxg</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getNameXPtg(java.lang.String,%20org.apache.poi.ss.formula.SheetIdentifier)">getNameXPtg</a></strong>(java.lang.String name, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</code> </td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula">EvaluationSheet</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheet(int)">getSheet</a></strong>(int sheetIndex)</code> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheetFirstNameByExternSheet(int)">getSheetFirstNameByExternSheet</a></strong>(int externSheetIndex)</code> </td> -</tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheetIndex(org.apache.poi.ss.formula.EvaluationSheet)">getSheetIndex</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula">EvaluationSheet</a> evalSheet)</code> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></strong>(java.lang.String sheetName)</code> -<div class="block">Finds a sheet index by case insensitive name.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheetLastNameByExternSheet(int)">getSheetLastNameByExternSheet</a></strong>(int externSheetIndex)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int sheetIndex)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></strong>()</code> -<div class="block">Returns an enum holding spreadhseet properties specific to an Excel version ( - max column and row numbers, max arguments to a function, etc.)</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#getUDFFinder()">getUDFFinder</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html#resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)">resolveNameXText</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a> n)</code> </td> -</tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.xssf.usermodel.BaseXSSFEvaluationWorkbook"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.poi.xssf.usermodel.<a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFEvaluationWorkbook</a></h3> +<code><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#convertFromExternSheetIndex(int)">convertFromExternSheetIndex</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.AreaReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalName(int,%20int)">getExternalName</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalName(java.lang.String,%20java.lang.String,%20int)">getExternalName</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalSheet(int)">ge tExternalSheet</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalSheet(java.lang.String,%20java.lang.String,%20int)">getExternalSheet</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalSheetIndex(java.lang.String)">getExternalSheetIndex</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getExternalSheetIndex(java.lang.String,%20java.lang.String)">getExternalSheetIndex</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getName(org.apache.poi.ss.formula.ptg.NamePtg)">getName</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getName(java.lang.String,%20int)">getName</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getNameText(org.apache.poi.ss.formula.ptg.NamePtg)">getNameText</a>, <a href="../../../../../org/apache/poi/xssf /usermodel/BaseXSSFEvaluationWorkbook.html#getNameXPtg(java.lang.String,%20org.apache.poi.ss.formula.SheetIdentifier)">getNameXPtg</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getSheetFirstNameByExternSheet(int)">getSheetFirstNameByExternSheet</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getSheetLastNameByExternSheet(int)">getSheetLastNameByExternSheet</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getSheetName(int)">getSheetName</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#getUDFFinder()">getUDFFinder</a>, <a href="../../../../../or g/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.html#resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)">resolveNameXText</a></code></li> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> @@ -298,54 +208,6 @@ implements <a href="../../../../../org/a <pre>public static <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFEvaluationWorkbook</a> create(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> book)</pre> </li> </ul> -<a name="convertFromExternSheetIndex(int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>convertFromExternSheetIndex</h4> -<pre>public int convertFromExternSheetIndex(int externSheetIndex)</pre> -<div class="block">XSSF doesn't use external sheet indexes, so when asked treat - it just as a local index</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#convertFromExternSheetIndex(int)">convertFromExternSheetIndex</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getExternalSheetIndex(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalSheetIndex</h4> -<pre>public int getExternalSheetIndex(java.lang.String sheetName)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getExternalSheetIndex(java.lang.String)">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">gets the externSheet index for a sheet from this workbook</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getExternalSheetIndex(java.lang.String)">getExternalSheetIndex</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getName(java.lang.String, int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getName</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationName.html" title="interface in org.apache.poi.ss.formula">EvaluationName</a> getName(java.lang.String name, - int sheetIndex)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getName(java.lang.String,%20int)">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">named range name matching is case insensitive</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getName(java.lang.String,%20int)">getName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getName(java.lang.String,%20int)">getName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> -</li> -</ul> <a name="getSheetIndex(org.apache.poi.ss.formula.EvaluationSheet)"> <!-- --> </a> @@ -353,117 +215,7 @@ implements <a href="../../../../../org/a <li class="blockList"> <h4>getSheetIndex</h4> <pre>public int getSheetIndex(<a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula">EvaluationSheet</a> evalSheet)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheetIndex(org.apache.poi.ss.formula.EvaluationSheet)">getSheetIndex</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>-1 if the specified sheet is from a different book</dd></dl> -</li> -</ul> -<a name="getSheetName(int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSheetName</h4> -<pre>public java.lang.String getSheetName(int sheetIndex)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheetName(int)">getSheetName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getExternalName(int, int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalName</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a> getExternalName(int externSheetIndex, - int externNameIndex)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalName(int,%20int)">EvaluationWorkbook</a></code></strong></div> -<div class="block">HSSF Only - fetch the external-style name details</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalName(int,%20int)">getExternalName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getExternalName(java.lang.String, java.lang.String, int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalName</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalName.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalName</a> getExternalName(java.lang.String nameName, - java.lang.String sheetName, - int externalWorkbookNumber)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalName(java.lang.String,%20java.lang.String,%20int)">EvaluationWorkbook</a></code></strong></div> -<div class="block">XSSF Only - fetch the external-style name details</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalName(java.lang.String,%20java.lang.String,%20int)">getExternalName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getNameXPtg(java.lang.String, org.apache.poi.ss.formula.SheetIdentifier)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getNameXPtg</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPxg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPxg</a> getNameXPtg(java.lang.String name, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getNameXPtg(java.lang.String,%20org.apache.poi.ss.formula.SheetIdentifier)">getNameXPtg</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="get3DReferencePtg(org.apache.poi.ss.util.CellReference, org.apache.poi.ss.formula.SheetIdentifier)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get3DReferencePtg</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a> get3DReferencePtg(<a href="../../../../../org/apache/poi/ss/util/CellReference.html" title="class in org.apache.poi.ss.util">CellReference</a> cell, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.formula.SheetIdentifier)">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">Produce the appropriate Ptg for a 3d cell reference</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.CellReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="get3DReferencePtg(org.apache.poi.ss.util.AreaReference, org.apache.poi.ss.formula.SheetIdentifier)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get3DReferencePtg</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a> get3DReferencePtg(<a href="../../../../../org/apache/poi/ss/util/AreaReference.html" title="class in org.apache.poi.ss.util">AreaReference</a> area, - <a href="../../../../../org/apache/poi/ss/formula/SheetIdentifier.html" title="class in org.apache.poi.ss.formula">SheetIdentifier</a> sheet)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.AreaReference,%20org.apache.poi.ss.formula.SheetIdentifier)">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">Produce the appropriate Ptg for a 3d area reference</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#get3DReferencePtg(org.apache.poi.ss.util.AreaReference,%20org.apache.poi.ss.formula.SheetIdentifier)">get3DReferencePtg</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>resolveNameXText</h4> -<pre>public java.lang.String resolveNameXText(<a href="../../../../../org/apache/poi/ss/formula/ptg/NameXPtg.html" title="class in org.apache.poi.ss.formula.ptg">NameXPtg</a> n)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)">resolveNameXText</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html#resolveNameXText(org.apache.poi.ss.formula.ptg.NameXPtg)">resolveNameXText</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a></code></dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>-1 if the specified sheet is from a different book</dd></dl> </li> </ul> <a name="getSheet(int)"> @@ -473,171 +225,15 @@ implements <a href="../../../../../org/a <li class="blockList"> <h4>getSheet</h4> <pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationSheet.html" title="interface in org.apache.poi.ss.formula">EvaluationSheet</a> getSheet(int sheetIndex)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheet(int)">getSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getExternalSheet(int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalSheet</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a> getExternalSheet(int externSheetIndex)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalSheet(int)">EvaluationWorkbook</a></code></strong></div> -<div class="block">HSSF Only - fetch the external-style sheet details - <p>Return will have no workbook set if it's actually in our own workbook</p></div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalSheet(int)">getExternalSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html#getExternalSheet(int)">getExternalSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd><code>null</code> if externSheetIndex refers to a sheet inside the current workbook</dd></dl> -</li> -</ul> -<a name="getExternalSheet(java.lang.String, java.lang.String, int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalSheet</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.ExternalSheet.html" title="class in org.apache.poi.ss.formula">EvaluationWorkbook.ExternalSheet</a> getExternalSheet(java.lang.String firstSheetName, - java.lang.String lastSheetName, - int externalWorkbookNumber)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalSheet(java.lang.String,%20java.lang.String,%20int)">EvaluationWorkbook</a></code></strong></div> -<div class="block">XSSF Only - fetch the external-style sheet details - <p>Return will have no workbook set if it's actually in our own workbook</p></div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getExternalSheet(java.lang.String,%20java.lang.String,%20int)">getExternalSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getExternalSheetIndex(java.lang.String, java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getExternalSheetIndex</h4> -<pre>public int getExternalSheetIndex(java.lang.String workbookName, - java.lang.String sheetName)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getExternalSheetIndex(java.lang.String,%20java.lang.String)">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">gets the externSheet index for a sheet from an external workbook</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getExternalSheetIndex(java.lang.String,%20java.lang.String)">getExternalSheetIndex</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>workbookName</code> - e.g. "Budget.xls"</dd><dd><code>sheetName</code> - a name of a sheet in that workbook</dd></dl> -</li> -</ul> -<a name="getSheetIndex(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSheetIndex</h4> -<pre>public int getSheetIndex(java.lang.String sheetName)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheetIndex(java.lang.String)">EvaluationWorkbook</a></code></strong></div> -<div class="block">Finds a sheet index by case insensitive name.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>the index of the sheet matching the specified name. -1 if not found</dd></dl> -</li> -</ul> -<a name="getSheetFirstNameByExternSheet(int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSheetFirstNameByExternSheet</h4> -<pre>public java.lang.String getSheetFirstNameByExternSheet(int externSheetIndex)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html#getSheetFirstNameByExternSheet(int)">getSheetFirstNameByExternSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>the name of the (first) sheet referred to by the given external sheet index</dd></dl> -</li> -</ul> -<a name="getSheetLastNameByExternSheet(int)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSheetLastNameByExternSheet</h4> -<pre>public java.lang.String getSheetLastNameByExternSheet(int externSheetIndex)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html#getSheetLastNameByExternSheet(int)">getSheetLastNameByExternSheet</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>the name of the (last) sheet referred to by the given external sheet index</dd></dl> -</li> -</ul> -<a name="getNameText(org.apache.poi.ss.formula.ptg.NamePtg)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getNameText</h4> -<pre>public java.lang.String getNameText(<a href="../../../../../org/apache/poi/ss/formula/ptg/NamePtg.html" title="class in org.apache.poi.ss.formula.ptg">NamePtg</a> namePtg)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html#getNameText(org.apache.poi.ss.formula.ptg.NamePtg)">getNameText</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaRenderingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaRenderingWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getName(org.apache.poi.ss.formula.ptg.NamePtg)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getName</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/EvaluationName.html" title="interface in org.apache.poi.ss.formula">EvaluationName</a> getName(<a href="../../../../../org/apache/poi/ss/formula/ptg/NamePtg.html" title="class in org.apache.poi.ss.formula.ptg">NamePtg</a> namePtg)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getName(org.apache.poi.ss.formula.ptg.NamePtg)">getName</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> </li> </ul> <a name="getFormulaTokens(org.apache.poi.ss.formula.EvaluationCell)"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>getFormulaTokens</h4> <pre>public <a href="../../../../../org/apache/poi/ss/formula/ptg/Ptg.html" title="class in org.apache.poi.ss.formula.ptg">Ptg</a>[] getFormulaTokens(<a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a> evalCell)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getFormulaTokens(org.apache.poi.ss.formula.EvaluationCell)">getFormulaTokens</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getUDFFinder()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getUDFFinder</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a> getUDFFinder()</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html#getUDFFinder()">getUDFFinder</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/EvaluationWorkbook.html" title="interface in org.apache.poi.ss.formula">EvaluationWorkbook</a></code></dd> -</dl> -</li> -</ul> -<a name="getSpreadsheetVersion()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getSpreadsheetVersion</h4> -<pre>public <a href="../../../../../org/apache/poi/ss/SpreadsheetVersion.html" title="enum in org.apache.poi.ss">SpreadsheetVersion</a> getSpreadsheetVersion()</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getSpreadsheetVersion()">FormulaParsingWorkbook</a></code></strong></div> -<div class="block">Returns an enum holding spreadhseet properties specific to an Excel version ( - max column and row numbers, max arguments to a function, etc.)</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html#getSpreadsheetVersion()">getSpreadsheetVersion</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/formula/FormulaParsingWorkbook.html" title="interface in org.apache.poi.ss.formula">FormulaParsingWorkbook</a></code></dd> -</dl> </li> </ul> </li> @@ -692,7 +288,7 @@ implements <a href="../../../../../org/a <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.xssf.usermodel.BaseXSSFEvaluationWorkbook">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul>
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html?rev=1693667&r1=1693666&r2=1693667&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html Fri Jul 31 23:09:47 2015 @@ -85,10 +85,15 @@ <li>java.lang.Object</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"> <li>org.apache.poi.xssf.usermodel.XSSFFormulaEvaluator</li> </ul> </li> </ul> +</li> +</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> @@ -98,16 +103,13 @@ </dl> <hr> <br> -<pre>public class <span class="strong">XSSFFormulaEvaluator</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> +<pre>public final class <span class="strong">XSSFFormulaEvaluator</span> +extends <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a></pre> <div class="block">Evaluates formula cells.<p/> For performance reasons, this class keeps a cache of all previously calculated intermediate - cell values. Be sure to call <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#clearAllCachedResultValues()"><code>clearAllCachedResultValues()</code></a> if any workbook cells are changed between + cell values. Be sure to call <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#clearAllCachedResultValues()"><code>BaseXSSFFormulaEvaluator.clearAllCachedResultValues()</code></a> if any workbook cells are changed between calls to evaluate~ methods on this class.</div> -<dl><dt><span class="strong">Author:</span></dt> - <dd>Amol S. Deshmukh < amolweb at ya hoo dot com >, Josh Micich</dd></dl> </li> </ul> </div> @@ -123,18 +125,17 @@ implements <a href="../../../../../org/a <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="colOne" scope="col">Constructor and Description</th> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook)">XSSFFormulaEvaluator</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook)</code> </td> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook)">XSSFFormulaEvaluator</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook)</code> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook,%20org.apache.poi.ss.formula.IStabilityClassifier)">XSSFFormulaEvaluator</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook, - <a href="../../../../../org/apache/poi/ss/formula/IStabilityClassifier.html" title="interface in org.apache.poi.ss.formula">IStabilityClassifier</a> stabilityClassifier)</code> -<div class="block"><strong>Deprecated.</strong> -<div class="block"><i>(Sep 2009) (reduce overloading) use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#create(org.apache.poi.xssf.usermodel.XSSFWorkbook,%20org.apache.poi.ss.formula.IStabilityClassifier,%20org.apache.poi.ss.formula.udf.UDFFinder)"><code>create(XSSFWorkbook, org.apache.poi.ss.formula.IStabilityClassifier, org.apache.poi.ss.formula.udf.UDFFinder)</code></a></i></div> -</div> -</td> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook,%20org.apache.poi.ss.formula.WorkbookEvaluator)">XSSFFormulaEvaluator</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook, + <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> @@ -152,52 +153,25 @@ 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/XSSFFormulaEvaluator.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/XSSFFormulaEvaluator.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>static <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">XSSFFormulaEvaluator</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#create(org.apache.poi.xssf.usermodel.XSSFWorkbook,%20org.apache.poi.ss.formula.IStabilityClassifier,%20org.apache.poi.ss.formula.udf.UDFFinder)">create</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook, <a href="../../../../../org/apache/poi/ss/formula/IStabilityClassifier.html" title="interface in org.apache.poi.ss.formula">IStabilityClassifier</a> stabilityClassifier, <a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a> udfFinder)</code> </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/XSSFFormulaEvaluator.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>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#evaluateAll()">evaluateAll</a></strong>()</code> <div class="block">Loops over all cells in all sheets of the supplied workbook.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#evaluateAllFormulaCells(org.apache.poi.xssf.usermodel.XSSFWorkbook)">evaluateAllFormulaCells</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</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>int</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.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/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a></code></td> <td class="colLast"><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> @@ -207,49 +181,20 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.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"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.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"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.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/XSSFFormulaEvaluator.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/XSSFFormulaEvaluator.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/XSSFFormulaEvaluator.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 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"><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> </td> </tr> </table> <ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.xssf.usermodel.BaseXSSFFormulaEvaluator"> +<!-- --> +</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#notifyDeleteCell(org.apache.poi.ss.usermodel.Cell)">notifyDeleteCell</a>, <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#not ifySetFormula(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> +</ul> +<ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> @@ -279,19 +224,14 @@ implements <a href="../../../../../org/a <pre>public XSSFFormulaEvaluator(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook)</pre> </li> </ul> -<a name="XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook, org.apache.poi.ss.formula.IStabilityClassifier)"> +<a name="XSSFFormulaEvaluator(org.apache.poi.xssf.usermodel.XSSFWorkbook, org.apache.poi.ss.formula.WorkbookEvaluator)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>XSSFFormulaEvaluator</h4> -<pre>@Deprecated -public XSSFFormulaEvaluator(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook, - <a href="../../../../../org/apache/poi/ss/formula/IStabilityClassifier.html" title="interface in org.apache.poi.ss.formula">IStabilityClassifier</a> stabilityClassifier)</pre> -<div class="block"><span class="strong">Deprecated.</span> <i>(Sep 2009) (reduce overloading) use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#create(org.apache.poi.xssf.usermodel.XSSFWorkbook,%20org.apache.poi.ss.formula.IStabilityClassifier,%20org.apache.poi.ss.formula.udf.UDFFinder)"><code>create(XSSFWorkbook, org.apache.poi.ss.formula.IStabilityClassifier, org.apache.poi.ss.formula.udf.UDFFinder)</code></a></i></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stabilityClassifier</code> - used to optimise caching performance. Pass <code>null</code> - for the (conservative) assumption that any cell may have its definition changed after - evaluation begins.</dd></dl> +<pre>protected XSSFFormulaEvaluator(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html" title="class in org.apache.poi.xssf.usermodel">XSSFWorkbook</a> workbook, + <a href="../../../../../org/apache/poi/ss/formula/WorkbookEvaluator.html" title="class in org.apache.poi.ss.formula">WorkbookEvaluator</a> bookEvaluator)</pre> </li> </ul> </li> @@ -316,121 +256,6 @@ public XSSFFormulaEvaluator(<a href evaluation begins.</dd><dd><code>udfFinder</code> - pass <code>null</code> for default (AnalysisToolPak only)</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. - 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> -<ul class="blockList"> -<li class="blockList"> -<h4>notifySetFormula</h4> -<pre>public void notifySetFormula(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifySetFormula(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 (value or formula) cell - 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)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>notifyDeleteCell</h4> -<pre>public void notifyDeleteCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<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)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>notifyUpdateCell</h4> -<pre>public void notifyUpdateCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#notifyUpdateCell(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 (value or formula) cell - 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/XSSFFormulaEvaluator.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 HSSFCell.CELL_TYPE_FORMULA however)</dd></dl> -</li> -</ul> <a name="evaluateInCell(org.apache.poi.ss.usermodel.Cell)"> <!-- --> </a> @@ -443,18 +268,15 @@ public XSSFFormulaEvaluator(<a href of the old formula. Else if cell does not contain formula, this method leaves the cell unchanged. - Note that the same instance of HSSFCell is returned to + Note that the same instance of XSSFCell is returned to allow chained calls like: <pre> int evaluatedCellType = evaluator.evaluateInCell(cell).getCellType(); </pre> Be aware that your cell value will be changed to hold the result of the formula. If you simply want the formula - value computed for you, use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)"><code>evaluateFormulaCell(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#evaluateInCell(org.apache.poi.ss.usermodel.Cell)">evaluateInCell</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> + value computed for you, use <a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)"><code>BaseXSSFFormulaEvaluator.evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)</code></a> }</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - </dd></dl> </li> </ul> <a name="evaluateAllFormulaCells(org.apache.poi.xssf.usermodel.XSSFWorkbook)"> @@ -491,86 +313,20 @@ public XSSFFormulaEvaluator(<a href are made. This is a helpful wrapper around looping over all cells, and calling evaluateFormulaCell on each one.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/FormulaEvaluator.html#evaluateAll()">evaluateAll</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="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="toEvaluationCell(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>toEvaluationCell</h4> +<pre>protected <a href="../../../../../org/apache/poi/ss/formula/EvaluationCell.html" title="interface in org.apache.poi.ss.formula">EvaluationCell</a> toEvaluationCell(<a href="../../../../../org/apache/poi/ss/usermodel/Cell.html" title="interface in org.apache.poi.ss.usermodel">Cell</a> cell)</pre> +<div class="block">Turns a XSSFCell into a XSSFEvaluationCell</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/xssf/usermodel/BaseXSSFFormulaEvaluator.html#toEvaluationCell(org.apache.poi.ss.usermodel.Cell)">toEvaluationCell</a></code> in class <code><a href="../../../../../org/apache/poi/xssf/usermodel/BaseXSSFFormulaEvaluator.html" title="class in org.apache.poi.xssf.usermodel">BaseXSSFFormulaEvaluator</a></code></dd> +</dl> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFRichTextString.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFRichTextString.html?rev=1693667&r1=1693666&r2=1693667&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFRichTextString.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFRichTextString.html Fri Jul 31 23:09:47 2015 @@ -269,38 +269,45 @@ implements <a href="../../../../../org/a </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#hasFormatting()">hasFormatting</a></strong>()</code> +<div class="block">Does this string have any explicit formatting applied, or is + it just text in the default style?</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/XSSFRichTextString.html#length()">length</a></strong>()</code> <div class="block">Returns the number of characters in this string.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#numFormattingRuns()">numFormattingRuns</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>protected static void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#preserveSpaces(org.openxmlformats.schemas.spreadsheetml.x2006.main.STXstring)">preserveSpaces</a></strong>(org.openxmlformats.schemas.spreadsheetml.x2006.main.STXstring xs)</code> <div class="block">Add the xml:spaces="preserve" attribute if the string has leading or trailing spaces</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/XSSFRichTextString.html#setString(java.lang.String)">setString</a></strong>(java.lang.String s)</code> <div class="block">Removes any formatting and sets new string value</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#setStylesTableReference(org.apache.poi.xssf.model.StylesTable)">setStylesTableReference</a></strong>(<a href="../../../../../org/apache/poi/xssf/model/StylesTable.html" title="class in org.apache.poi.xssf.model">StylesTable</a> tbl)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected static org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFont</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#toCTFont(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt)">toCTFont</a></strong>(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt pr)</code> <div class="block">CTRPrElt --> CTFont adapter</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFRichTextString.html#toString()">toString</a></strong>()</code> <div class="block">Returns the plain string representation.</div> @@ -449,6 +456,17 @@ implements <a href="../../../../../org/a <dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the text to append</dd></dl> </li> </ul> +<a name="hasFormatting()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasFormatting</h4> +<pre>public boolean hasFormatting()</pre> +<div class="block">Does this string have any explicit formatting applied, or is + it just text in the default style?</div> +</li> +</ul> <a name="clearFormatting()"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html?rev=1693667&r1=1693666&r2=1693667&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html Fri Jul 31 23:09:47 2015 @@ -531,7 +531,7 @@ implements <a href="../../../../../org/a <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getWorkbookType()">getWorkbookType</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>protected boolean</code></td> +<td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isDate1904()">isDate1904</a></strong>()</code> <div class="block">Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.</div> </td> @@ -1970,7 +1970,8 @@ public <a href="../../../../../org/ <ul class="blockList"> <li class="blockList"> <h4>isDate1904</h4> -<pre>protected boolean isDate1904()</pre> +<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a> +public boolean isDate1904()</pre> <div class="block">Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904. <p> The default value is false, meaning that the workbook uses the 1900 date system, --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org For additional commands, e-mail: commits-h...@poi.apache.org
