/* ====================================================================
|
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.
|
==================================================================== */
|
|
using System;
|
using HH.WMS.Utils.NPOI.HSSF.UserModel;
|
using HH.WMS.Utils.NPOI.SS.Formula;
|
using HH.WMS.Utils.NPOI.SS.Formula.Eval;
|
using HH.WMS.Utils.NPOI.SS.Formula.Udf;
|
using HH.WMS.Utils.NPOI.SS.UserModel;
|
namespace HH.WMS.Utils.NPOI.SS.Formula.Eval.Forked
|
{
|
|
|
/**
|
* An alternative workbook Evaluator that saves memory in situations where a single workbook is
|
* concurrently and independently Evaluated many times. With standard formula Evaluation, around
|
* 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link HH.WMS.Utils.NPOI.xssf.usermodel.XSSFWorkbook}.
|
* This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
|
* clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
|
* that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
|
*
|
* @author Josh Micich
|
*/
|
public class ForkedEvaluator
|
{
|
|
private WorkbookEvaluator _evaluator;
|
private ForkedEvaluationWorkbook _sewb;
|
|
private ForkedEvaluator(IEvaluationWorkbook masterWorkbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
|
{
|
_sewb = new ForkedEvaluationWorkbook(masterWorkbook);
|
_evaluator = new WorkbookEvaluator(_sewb, stabilityClassifier, udfFinder);
|
}
|
private static IEvaluationWorkbook CreateEvaluationWorkbook(IWorkbook wb)
|
{
|
if (wb is HSSFWorkbook)
|
{
|
return HSSFEvaluationWorkbook.Create((HSSFWorkbook)wb);
|
}
|
// TODO rearrange POI build to allow this
|
// if (wb is XSSFWorkbook) {
|
// return XSSFEvaluationWorkbook.Create((XSSFWorkbook) wb);
|
// }
|
throw new ArgumentException("Unexpected workbook type (" + wb.GetType().Name + ")");
|
}
|
/**
|
* @deprecated (Sep 2009) (reduce overloading) use {@link #Create(Workbook, IStabilityClassifier, UDFFinder)}
|
*/
|
public static ForkedEvaluator Create(IWorkbook wb, IStabilityClassifier stabilityClassifier)
|
{
|
return Create(wb, stabilityClassifier, null);
|
}
|
/**
|
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
|
*/
|
public static ForkedEvaluator Create(IWorkbook wb, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
|
{
|
return new ForkedEvaluator(CreateEvaluationWorkbook(wb), stabilityClassifier, udfFinder);
|
}
|
|
/**
|
* Sets the specified cell to the supplied <tt>value</tt>
|
* @param sheetName the name of the sheet Containing the cell
|
* @param rowIndex zero based
|
* @param columnIndex zero based
|
*/
|
public void UpdateCell(String sheetName, int rowIndex, int columnIndex, ValueEval value)
|
{
|
|
ForkedEvaluationCell cell = _sewb.GetOrCreateUpdatableCell(sheetName, rowIndex, columnIndex);
|
cell.SetValue(value);
|
_evaluator.NotifyUpdateCell(cell);
|
}
|
/**
|
* Copies the values of all updated cells (modified by calls to {@link
|
* #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
|
* Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
|
* but at the very least it must contain sheets with the same names.
|
*/
|
public void CopyUpdatedCells(IWorkbook workbook)
|
{
|
_sewb.CopyUpdatedCells(workbook);
|
}
|
|
/**
|
* 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.
|
*
|
* @param sheetName the name of the sheet Containing the cell
|
* @param rowIndex zero based
|
* @param columnIndex zero based
|
* @return <code>null</code> if the supplied cell is <code>null</code> or blank
|
*/
|
public ValueEval Evaluate(String sheetName, int rowIndex, int columnIndex)
|
{
|
IEvaluationCell cell = _sewb.GetEvaluationCell(sheetName, rowIndex, columnIndex);
|
|
switch (cell.CellType)
|
{
|
case CellType.BOOLEAN:
|
return BoolEval.ValueOf(cell.BooleanCellValue);
|
case CellType.ERROR:
|
return ErrorEval.ValueOf(cell.ErrorCellValue);
|
case CellType.FORMULA:
|
return _evaluator.Evaluate(cell);
|
case CellType.NUMERIC:
|
return new NumberEval(cell.NumericCellValue);
|
case CellType.STRING:
|
return new StringEval(cell.StringCellValue);
|
case CellType.BLANK:
|
return null;
|
}
|
throw new InvalidOperationException("Bad cell type (" + cell.CellType + ")");
|
}
|
/**
|
* 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, ForkedEvaluator[] Evaluators)
|
{
|
WorkbookEvaluator[] wbEvals = new WorkbookEvaluator[Evaluators.Length];
|
for (int i = 0; i < wbEvals.Length; i++)
|
{
|
wbEvals[i] = Evaluators[i]._evaluator;
|
}
|
CollaboratingWorkbooksEnvironment.Setup(workbookNames, wbEvals);
|
}
|
}
|
|
}
|
