304 lines
12 KiB
Java
304 lines
12 KiB
Java
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
==================================================================== */
|
|
|
|
package org.apache.poi.hssf.usermodel;
|
|
|
|
import java.util.Map;
|
|
|
|
import org.apache.poi.ss.formula.BaseFormulaEvaluator;
|
|
import org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment;
|
|
import org.apache.poi.ss.formula.IStabilityClassifier;
|
|
import org.apache.poi.ss.formula.WorkbookEvaluator;
|
|
import org.apache.poi.ss.formula.eval.BoolEval;
|
|
import org.apache.poi.ss.formula.eval.ErrorEval;
|
|
import org.apache.poi.ss.formula.eval.NumericValueEval;
|
|
import org.apache.poi.ss.formula.eval.StringValueEval;
|
|
import org.apache.poi.ss.formula.eval.ValueEval;
|
|
import org.apache.poi.ss.formula.udf.UDFFinder;
|
|
import org.apache.poi.ss.usermodel.Cell;
|
|
import org.apache.poi.ss.usermodel.CellType;
|
|
import org.apache.poi.ss.usermodel.CellValue;
|
|
import org.apache.poi.ss.usermodel.FormulaEvaluator;
|
|
import org.apache.poi.ss.usermodel.Workbook;
|
|
import org.apache.poi.util.Internal;
|
|
|
|
/**
|
|
* Evaluates formula cells.<p/>
|
|
*
|
|
* For performance reasons, this class keeps a cache of all previously calculated intermediate
|
|
* cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
|
|
* calls to evaluate~ methods on this class.
|
|
*/
|
|
public class HSSFFormulaEvaluator extends BaseFormulaEvaluator {
|
|
private final HSSFWorkbook _book;
|
|
|
|
public HSSFFormulaEvaluator(HSSFWorkbook workbook) {
|
|
this(workbook, null);
|
|
}
|
|
/**
|
|
* @param workbook The workbook to perform the formula evaluations in
|
|
* @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
|
|
* for the (conservative) assumption that any cell may have its definition changed after
|
|
* evaluation begins.
|
|
*/
|
|
public HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier) {
|
|
this(workbook, stabilityClassifier, null);
|
|
}
|
|
|
|
/**
|
|
* @param workbook The workbook to perform the formula evaluations in
|
|
* @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
|
|
* for the (conservative) assumption that any cell may have its definition changed after
|
|
* evaluation begins.
|
|
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
|
|
*/
|
|
private HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
|
|
super(new WorkbookEvaluator(HSSFEvaluationWorkbook.create(workbook), stabilityClassifier, udfFinder));
|
|
_book = workbook;
|
|
}
|
|
|
|
/**
|
|
* @param workbook The workbook to perform the formula evaluations in
|
|
* @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
|
|
* for the (conservative) assumption that any cell may have its definition changed after
|
|
* evaluation begins.
|
|
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
|
|
*/
|
|
public static HSSFFormulaEvaluator create(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
|
|
return new HSSFFormulaEvaluator(workbook, stabilityClassifier, udfFinder);
|
|
}
|
|
|
|
|
|
/**
|
|
* Coordinates several formula evaluators together so that formulas that involve external
|
|
* references can be evaluated.
|
|
* @param workbookNames the simple file names used to identify the workbooks in formulas
|
|
* with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
|
|
* @param evaluators all evaluators for the full set of workbooks required by the formulas.
|
|
*/
|
|
public static void setupEnvironment(String[] workbookNames, HSSFFormulaEvaluator[] evaluators) {
|
|
BaseFormulaEvaluator.setupEnvironment(workbookNames, evaluators);
|
|
}
|
|
|
|
@Override
|
|
public void setupReferencedWorkbooks(Map<String, FormulaEvaluator> evaluators) {
|
|
CollaboratingWorkbooksEnvironment.setupFormulaEvaluator(evaluators);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public void notifyUpdateCell(HSSFCell cell) {
|
|
_bookEvaluator.notifyUpdateCell(new HSSFEvaluationCell(cell));
|
|
}
|
|
@Override
|
|
public void notifyUpdateCell(Cell cell) {
|
|
_bookEvaluator.notifyUpdateCell(new HSSFEvaluationCell((HSSFCell)cell));
|
|
}
|
|
/**
|
|
* Should be called to tell the cell value cache that the specified cell has just been
|
|
* deleted.
|
|
* Failure to call this method after changing cell values will cause incorrect behaviour
|
|
* of the evaluate~ methods of this class
|
|
*/
|
|
public void notifyDeleteCell(HSSFCell cell) {
|
|
_bookEvaluator.notifyDeleteCell(new HSSFEvaluationCell(cell));
|
|
}
|
|
@Override
|
|
public void notifyDeleteCell(Cell cell) {
|
|
_bookEvaluator.notifyDeleteCell(new HSSFEvaluationCell((HSSFCell)cell));
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
@Override
|
|
public void notifySetFormula(Cell cell) {
|
|
_bookEvaluator.notifyUpdateCell(new HSSFEvaluationCell((HSSFCell)cell));
|
|
}
|
|
|
|
/**
|
|
* If cell contains formula, it evaluates the formula, and saves the result of the formula. The
|
|
* cell remains as a formula cell. If the cell does not contain formula, rather than throwing an
|
|
* exception, this method returns {@link CellType#_NONE} 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>
|
|
* CellType evaluatedCellType = evaluator.evaluateFormulaCell(cell);
|
|
* </pre>
|
|
* Be aware that your cell will hold both the formula, and the result. If you want the cell
|
|
* replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
|
|
* @param cell The cell to evaluate
|
|
* @return {@link CellType#_NONE} for non-formula cells, or the type of the <em>formula result</em>
|
|
* @since POI 3.15 beta 3
|
|
* @deprecated POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.
|
|
*/
|
|
@Internal
|
|
@Override
|
|
public CellType evaluateFormulaCellEnum(Cell cell) {
|
|
if (cell == null || cell.getCellTypeEnum() != CellType.FORMULA) {
|
|
return CellType._NONE;
|
|
}
|
|
CellValue cv = evaluateFormulaCellValue(cell);
|
|
// cell remains a formula cell, but the cached value is changed
|
|
setCellValue(cell, cv);
|
|
return cv.getCellType();
|
|
}
|
|
|
|
/**
|
|
* If cell contains formula, it evaluates the formula, and
|
|
* puts the formula result back into the cell, in place
|
|
* 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
|
|
* 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 {@link #evaluateFormulaCellEnum(Cell)}}
|
|
*/
|
|
@Override
|
|
public HSSFCell evaluateInCell(Cell cell) {
|
|
if (cell == null) {
|
|
return null;
|
|
}
|
|
HSSFCell result = (HSSFCell) cell;
|
|
if (cell.getCellTypeEnum() == CellType.FORMULA) {
|
|
CellValue cv = evaluateFormulaCellValue(cell);
|
|
setCellValue(cell, cv);
|
|
setCellType(cell, cv); // cell will no longer be a formula cell
|
|
}
|
|
return result;
|
|
}
|
|
|
|
private static void setCellValue(Cell cell, CellValue cv) {
|
|
CellType cellType = cv.getCellType();
|
|
switch (cellType) {
|
|
case BOOLEAN:
|
|
cell.setCellValue(cv.getBooleanValue());
|
|
break;
|
|
case ERROR:
|
|
cell.setCellErrorValue(cv.getErrorValue());
|
|
break;
|
|
case NUMERIC:
|
|
cell.setCellValue(cv.getNumberValue());
|
|
break;
|
|
case STRING:
|
|
cell.setCellValue(new HSSFRichTextString(cv.getStringValue()));
|
|
break;
|
|
case BLANK:
|
|
// never happens - blanks eventually get translated to zero
|
|
case FORMULA:
|
|
// this will never happen, we have already evaluated the formula
|
|
default:
|
|
throw new IllegalStateException("Unexpected cell value type (" + cellType + ")");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Loops over all cells in all sheets of the supplied
|
|
* workbook.
|
|
* For cells that contain formulas, their formulas are
|
|
* evaluated, and the results are saved. These cells
|
|
* remain as formula cells.
|
|
* For cells that do not contain formulas, no changes
|
|
* are made.
|
|
* This is a helpful wrapper around looping over all
|
|
* cells, and calling evaluateFormulaCell on each one.
|
|
*/
|
|
public static void evaluateAllFormulaCells(HSSFWorkbook wb) {
|
|
evaluateAllFormulaCells(wb, new HSSFFormulaEvaluator(wb));
|
|
}
|
|
|
|
/**
|
|
* Loops over all cells in all sheets of the supplied
|
|
* workbook.
|
|
* For cells that contain formulas, their formulas are
|
|
* evaluated, and the results are saved. These cells
|
|
* remain as formula cells.
|
|
* For cells that do not contain formulas, no changes
|
|
* are made.
|
|
* This is a helpful wrapper around looping over all
|
|
* cells, and calling evaluateFormulaCell on each one.
|
|
*/
|
|
public static void evaluateAllFormulaCells(Workbook wb) {
|
|
BaseFormulaEvaluator.evaluateAllFormulaCells(wb);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@Override
|
|
public void evaluateAll() {
|
|
evaluateAllFormulaCells(_book, this);
|
|
}
|
|
|
|
/**
|
|
* Returns a CellValue wrapper around the supplied ValueEval instance.
|
|
* @param cell
|
|
*/
|
|
protected CellValue evaluateFormulaCellValue(Cell cell) {
|
|
ValueEval eval = _bookEvaluator.evaluate(new HSSFEvaluationCell((HSSFCell)cell));
|
|
if (eval instanceof BoolEval) {
|
|
BoolEval be = (BoolEval) eval;
|
|
return CellValue.valueOf(be.getBooleanValue());
|
|
}
|
|
if (eval instanceof NumericValueEval) {
|
|
NumericValueEval ne = (NumericValueEval) eval;
|
|
return new CellValue(ne.getNumberValue());
|
|
}
|
|
if (eval instanceof StringValueEval) {
|
|
StringValueEval ne = (StringValueEval) eval;
|
|
return new CellValue(ne.getStringValue());
|
|
}
|
|
if (eval instanceof ErrorEval) {
|
|
return CellValue.getError(((ErrorEval)eval).getErrorCode());
|
|
}
|
|
throw new RuntimeException("Unexpected eval class (" + eval.getClass().getName() + ")");
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
@Override
|
|
public void setIgnoreMissingWorkbooks(boolean ignore){
|
|
_bookEvaluator.setIgnoreMissingWorkbooks(ignore);
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
@Override
|
|
public void setDebugEvaluationOutputForNextEval(boolean value){
|
|
_bookEvaluator.setDebugEvaluationOutputForNextEval(value);
|
|
}
|
|
}
|