moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Improvements to patch 47809 (support for UDFs)

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@816016 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Josh Micich 2009-09-17 00:00:57 +00:00
parent 6977f358dd
commit cae73922a6
23 changed files with 367 additions and 551 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/java/org/apache/poi/hssf/record/NameRecord.java
View File

@ -33,9 +33,7 @@ import org.apache.poi.util.StringUtil;
* @author Libin Roman (Vista Portal LDT. Developer)
* @author Sergei Kozello (sergeikozello at mail.ru)
* @author Glen Stampoultzis (glens at apache.org)
* @version 1.0-pre
*
* Modified 8/31/09 by Petr Udalau - added method setFunction(boolean)
* @author Petr Udalau - added method setFunction(boolean)
*/
public final class NameRecord extends StandardRecord {
public final static short sid = 0x0018;

28
src/java/org/apache/poi/hssf/record/formula/atp/AnalysisToolPak.java
View File

@ -22,14 +22,17 @@ import java.util.Map;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.hssf.record.formula.toolpack.ToolPack;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.NotImplementedException;
/**
* Modified 09/07/09 by Petr Udalau - systematized work of ToolPacks.
* @author Josh Micich
* @author Petr Udalau - systematized work of add-in libraries and user defined functions.
*/
public final class AnalysisToolPak implements ToolPack {
public final class AnalysisToolPak implements UDFFinder {
public static final UDFFinder instance = new AnalysisToolPak();
private static final class NotImplemented implements FreeRefFunction {
private final String _functionName;
@ -43,7 +46,12 @@ public final class AnalysisToolPak implements ToolPack {
}
};
private Map<String, FreeRefFunction> _functionsByName = createFunctionsMap();
private final Map<String, FreeRefFunction> _functionsByName = createFunctionsMap();
private AnalysisToolPak() {
// enforce singleton
}
public FreeRefFunction findFunction(String name) {
return _functionsByName.get(name);
@ -153,16 +161,4 @@ public final class AnalysisToolPak implements ToolPack {
FreeRefFunction func = pFunc == null ? new NotImplemented(functionName) : pFunc;
m.put(functionName, func);
}
public void addFunction(String name, FreeRefFunction evaluator) {
r(_functionsByName, name, evaluator);
}
public boolean containsFunction(String name) {
return _functionsByName.containsKey(name);
}
public void removeFunction(String name) {
_functionsByName.remove(name);
}
}

51
src/java/org/apache/poi/hssf/record/formula/eval/UserDefinedFunction.java
View File

@ -18,8 +18,6 @@
package org.apache.poi.hssf.record.formula.eval;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.hssf.record.formula.toolpack.MainToolPacksHandler;
import org.apache.poi.ss.formula.EvaluationWorkbook;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.NotImplementedException;
/**
@ -28,8 +26,7 @@ import org.apache.poi.ss.formula.eval.NotImplementedException;
* <tt>AbstractFunctionPtg.field_2_fnc_index</tt> == 255)
*
* @author Josh Micich
*
* Modified 09/07/09 by Petr Udalau - Improved resolving of UDFs through the ToolPacks.
* @author Petr Udalau - Improved resolving of UDFs through the ToolPacks.
*/
final class UserDefinedFunction implements FreeRefFunction {
@ -40,60 +37,28 @@ final class UserDefinedFunction implements FreeRefFunction {
}
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
EvaluationWorkbook workbook = ec.getWorkbook();
int nIncomingArgs = args.length;
if(nIncomingArgs < 1) {
throw new RuntimeException("function name argument missing");
}
ValueEval nameArg = args[0];
FreeRefFunction targetFunc;
String functionName;
if (nameArg instanceof NameEval) {
targetFunc = findInternalUserDefinedFunction(workbook, (NameEval) nameArg);
functionName = ((NameEval) nameArg).getFunctionName();
} else if (nameArg instanceof NameXEval) {
targetFunc = findExternalUserDefinedFunction(workbook, (NameXEval) nameArg);
functionName = ec.getWorkbook().resolveNameXText(((NameXEval) nameArg).getPtg());
} else {
throw new RuntimeException("First argument should be a NameEval, but got ("
+ nameArg.getClass().getName() + ")");
}
FreeRefFunction targetFunc = ec.findUserDefinedFunction(functionName);
if (targetFunc == null) {
throw new NotImplementedException(functionName);
}
int nOutGoingArgs = nIncomingArgs -1;
ValueEval[] outGoingArgs = new ValueEval[nOutGoingArgs];
System.arraycopy(args, 1, outGoingArgs, 0, nOutGoingArgs);
return targetFunc.evaluate(outGoingArgs, ec);
}
private static FreeRefFunction findExternalUserDefinedFunction(EvaluationWorkbook workbook,
NameXEval n) {
String functionName = workbook.resolveNameXText(n.getPtg());
if(false) {
System.out.println("received call to external user defined function (" + functionName + ")");
}
// currently only looking for functions from the 'Analysis TookPak'(contained in MainToolPacksHandler) e.g. "YEARFRAC" or "ISEVEN"
// not sure how much this logic would need to change to support other or multiple add-ins.
FreeRefFunction result = MainToolPacksHandler.instance().findFunction(functionName);
if (result != null) {
return result;
}
throw new NotImplementedException(functionName);
}
private static FreeRefFunction findInternalUserDefinedFunction(EvaluationWorkbook workbook,
NameEval functionNameEval) {
String functionName = functionNameEval.getFunctionName();
if(false) {
System.out.println("received call to internal user defined function (" + functionName + ")");
}
FreeRefFunction functionEvaluator = workbook.findUserDefinedFunction(functionName);
if (functionEvaluator == null) {
functionEvaluator = MainToolPacksHandler.instance().findFunction(functionName);
}
if (functionEvaluator != null) {
return functionEvaluator;
}
// TODO find the implementation for the user defined function
throw new NotImplementedException(functionName);
}
}

102
src/java/org/apache/poi/hssf/record/formula/toolpack/MainToolPacksHandler.java
View File

@ -1,102 +0,0 @@
/* ====================================================================
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.record.formula.toolpack;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.hssf.record.formula.atp.AnalysisToolPak;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
/**
* Contains all tool packs. Processing of UDF is through this class.
*
* @author PUdalau
*/
public class MainToolPacksHandler{
private DefaultToolPack defaultToolPack;
private List<ToolPack> usedToolPacks = new ArrayList<ToolPack>();
private static MainToolPacksHandler instance;
/**
* @return Unique instance of handler.
*/
public static MainToolPacksHandler instance() {
if (instance == null) {
instance = new MainToolPacksHandler();
}
return instance;
}
/**
* @return Default tool pack(which is obligatory exists in handler).
*/
public DefaultToolPack getDefaultToolPack() {
return defaultToolPack;
}
private MainToolPacksHandler() {
defaultToolPack = new DefaultToolPack();
usedToolPacks.add(defaultToolPack);
usedToolPacks.add(new AnalysisToolPak());
}
/**
* Checks if such function exists in any registered tool pack.
* @param name Name of function.
* @return true if some tool pack contains such function.
*/
public boolean containsFunction(String name) {
for (ToolPack pack : usedToolPacks) {
if (pack.containsFunction(name)) {
return true;
}
}
return false;
}
/**
* Returns executor by specified name. Returns <code>null</code> if
* function isn't contained by any registered tool pack.
*
* @param name
* Name of function.
* @return Function executor.
*/
public FreeRefFunction findFunction(String name) {
FreeRefFunction evaluatorForFunction;
for (ToolPack pack : usedToolPacks) {
evaluatorForFunction = pack.findFunction(name);
if (evaluatorForFunction != null) {
return evaluatorForFunction;
}
}
return null;
}
/**
* Registers new tool pack in handler.
* @param pack Tool pack to add.
*/
public void addToolPack(ToolPack pack) {
usedToolPacks.add(pack);
}
}

52
src/java/org/apache/poi/hssf/record/formula/udf/AggregatingUDFFinder.java Executable file
View File

@ -0,0 +1,52 @@
/* ====================================================================
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.record.formula.udf;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
/**
* Collects add-in libraries and VB macro functions together into one UDF finder
*
* @author PUdalau
*/
public final class AggregatingUDFFinder implements UDFFinder {
private final UDFFinder[] _usedToolPacks;
public AggregatingUDFFinder(UDFFinder ... usedToolPacks) {
_usedToolPacks = usedToolPacks.clone();
}
/**
* Returns executor by specified name. Returns <code>null</code> if
* function isn't contained by any registered tool pack.
*
* @param name Name of function.
* @return Function executor. <code>null</code> if not found
*/
public FreeRefFunction findFunction(String name) {
FreeRefFunction evaluatorForFunction;
for (UDFFinder pack : _usedToolPacks) {
evaluatorForFunction = pack.findFunction(name);
if (evaluatorForFunction != null) {
return evaluatorForFunction;
}
}
return null;
}
}

30
src/java/org/apache/poi/hssf/record/formula/toolpack/DefaultToolPack.java → src/java/org/apache/poi/hssf/record/formula/udf/DefaultUDFFinder.java
View File

@ -15,7 +15,7 @@
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.record.formula.toolpack;
package org.apache.poi.hssf.record.formula.udf;
import java.util.HashMap;
import java.util.Map;
@ -23,29 +23,27 @@ import java.util.Map;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
/**
* Default tool pack.
* If you want to add some UDF, but you don't want to create new tool pack, use this.
* Default UDF finder - for adding your own user defined functions.
*
* @author PUdalau
*/
public class DefaultToolPack implements ToolPack {
private Map<String, FreeRefFunction> functionsByName = new HashMap<String, FreeRefFunction>();
public final class DefaultUDFFinder implements UDFFinder {
private final Map<String, FreeRefFunction> _functionsByName;
public void addFunction(String name, FreeRefFunction evaluator) {
if (evaluator != null){
functionsByName.put(name, evaluator);
public DefaultUDFFinder(String[] functionNames, FreeRefFunction[] functionImpls) {
int nFuncs = functionNames.length;
if (functionImpls.length != nFuncs) {
throw new IllegalArgumentException(
"Mismatch in number of function names and implementations");
}
HashMap<String, FreeRefFunction> m = new HashMap<String, FreeRefFunction>(nFuncs * 3 / 2);
for (int i = 0; i < functionImpls.length; i++) {
m.put(functionNames[i], functionImpls[i]);
}
public boolean containsFunction(String name) {
return functionsByName.containsKey(name);
_functionsByName = m;
}
public FreeRefFunction findFunction(String name) {
return functionsByName.get(name);
}
public void removeFunction(String name) {
functionsByName.remove(name);
return _functionsByName.get(name);
}
}

32
src/java/org/apache/poi/hssf/record/formula/toolpack/ToolPack.java → src/java/org/apache/poi/hssf/record/formula/udf/UDFFinder.java
View File

@ -15,42 +15,24 @@
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.record.formula.toolpack;
package org.apache.poi.hssf.record.formula.udf;
import org.apache.poi.hssf.record.formula.atp.AnalysisToolPak;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
/**
* Common interface for any new tool pack with executors for functions.
* Common interface for "Add-in" libraries and user defined function libraries.
*
* @author PUdalau
*/
public interface ToolPack {
public interface UDFFinder {
public static final UDFFinder DEFAULT = new AggregatingUDFFinder(AnalysisToolPak.instance);
/**
* Returns executor by specified name. Returns <code>null</code> if tool
* pack doesn't contains such function.
* Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
*
* @param name Name of function.
* @return Function executor.
*/
FreeRefFunction findFunction(String name);
/**
* Add new function with executor.
* @param name Name of function.
* @param evaluator Function executor.
*/
void addFunction(String name, FreeRefFunction evaluator);
/**
* Returns executor by specified name if it exists.
* @param name Name of function.
*/
void removeFunction(String name);
/**
* Checks if such function exists in tool pack.
* @param name Name of function.
* @return true if tool pack contains such function.
*/
boolean containsFunction(String name);
}

15
src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java
View File

@ -24,16 +24,19 @@ import org.apache.poi.hssf.record.aggregates.FormulaRecordAggregate;
import org.apache.poi.hssf.record.formula.NamePtg;
import org.apache.poi.hssf.record.formula.NameXPtg;
import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.*;
import org.apache.poi.ss.SpreadsheetVersion;
import org.apache.poi.ss.formula.EvaluationCell;
import org.apache.poi.ss.formula.EvaluationName;
import org.apache.poi.ss.formula.EvaluationSheet;
import org.apache.poi.ss.formula.EvaluationWorkbook;
import org.apache.poi.ss.formula.FormulaParsingWorkbook;
import org.apache.poi.ss.formula.FormulaRenderingWorkbook;
import org.apache.poi.ss.formula.FormulaType;
/**
* Internal POI use only
*
* @author Josh Micich
*
* Modified 09/07/09 by Petr Udalau - added methods for searching for UDFs of this Workbook.
*/
public final class HSSFEvaluationWorkbook implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook {
@ -162,8 +165,4 @@ public final class HSSFEvaluationWorkbook implements FormulaRenderingWorkbook, E
public SpreadsheetVersion getSpreadsheetVersion(){
return SpreadsheetVersion.EXCEL97;
}
public FreeRefFunction findUserDefinedFunction(String functionName) {
return _uBook.getUserDefinedFunction(functionName);
}
}

21
src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
View File

@ -24,6 +24,7 @@ import org.apache.poi.hssf.record.formula.eval.ErrorEval;
import org.apache.poi.hssf.record.formula.eval.NumberEval;
import org.apache.poi.hssf.record.formula.eval.StringEval;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment;
import org.apache.poi.ss.formula.IStabilityClassifier;
import org.apache.poi.ss.formula.WorkbookEvaluator;
@ -64,9 +65,27 @@ public class HSSFFormulaEvaluator implements FormulaEvaluator {
* evaluation begins.
*/
public HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier) {
_bookEvaluator = new WorkbookEvaluator(HSSFEvaluationWorkbook.create(workbook), stabilityClassifier);
this(workbook, stabilityClassifier, null);
}
/**
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
*/
private HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
_bookEvaluator = new WorkbookEvaluator(HSSFEvaluationWorkbook.create(workbook), stabilityClassifier, udfFinder);
}
/**
* @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.

32
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -24,11 +24,9 @@ import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import org.apache.poi.POIDocument;
@ -64,12 +62,10 @@ import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.record.formula.Ref3DPtg;
import org.apache.poi.hssf.record.formula.SheetNameFormatter;
import org.apache.poi.hssf.record.formula.UnionPtg;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.hssf.util.CellReference;
import org.apache.poi.poifs.filesystem.DirectoryNode;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.formula.FormulaType;
import org.apache.poi.util.POILogFactory;
@ -86,9 +82,6 @@ import org.apache.poi.util.POILogger;
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Glen Stampoultzis (glens at apache.org)
* @author Shawn Laubach (slaubach at apache dot org)
*
*
* Modified 09/07/09 by Petr Udalau - added methods for work with UDFs of this Workbook.
*/
public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.usermodel.Workbook {
private static final Pattern COMMA_PATTERN = Pattern.compile(",");
@ -168,9 +161,6 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
private static POILogger log = POILogFactory.getLogger(HSSFWorkbook.class);
/** Map of user defined functions, key - function name, value - instance of FreeRefFunctions */
private Map<String, FreeRefFunction> udfFunctions;
/**
* Creates new HSSFWorkbook from scratch (start here!)
*
@ -186,7 +176,6 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
workbook = book;
_sheets = new ArrayList( INITIAL_CAPACITY );
names = new ArrayList( INITIAL_CAPACITY );
udfFunctions = new HashMap<String, FreeRefFunction>();
}
public HSSFWorkbook(POIFSFileSystem fs) throws IOException {
@ -278,7 +267,6 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
_sheets = new ArrayList(INITIAL_CAPACITY);
names = new ArrayList(INITIAL_CAPACITY);
udfFunctions = new HashMap<String, FreeRefFunction>();
// Grab the data from the workbook stream, however
// it happens to be spelled.
@ -1628,25 +1616,6 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
}
}
public FreeRefFunction getUserDefinedFunction(String functionName) {
return udfFunctions.get(functionName);
}
public void registerUserDefinedFunction(String functionName, FreeRefFunction freeRefFunction) {
Name udfDeclaration = getName(functionName);
if (udfDeclaration == null) {
udfDeclaration = createName();
}
udfDeclaration.setNameName(functionName);
udfDeclaration.setFunction(true);
udfFunctions.put(functionName, freeRefFunction);
}
public List<String> getUserDefinedFunctionNames() {
return new ArrayList<String>(udfFunctions.keySet());
}
/**
* Is the workbook protected with a password (not encrypted)?
*/
@ -1729,5 +1698,4 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
public NameXPtg getNameXPtg(String name) {
return workbook.getNameXPtg(name);
}
}

14
src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
View File

@ -20,7 +20,6 @@ package org.apache.poi.ss.formula;
import org.apache.poi.hssf.record.formula.NamePtg;
import org.apache.poi.hssf.record.formula.NameXPtg;
import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
/**
* Abstracts a workbook for the purpose of formula evaluation.<br/>
@ -28,8 +27,6 @@ import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
* For POI internal use only
*
* @author Josh Micich
*
* Modified 09/07/09 by Petr Udalau - added methods for searching for UDFs of this Workbook.
*/
public interface EvaluationWorkbook {
String getSheetName(int sheetIndex);
@ -54,17 +51,6 @@ public interface EvaluationWorkbook {
String resolveNameXText(NameXPtg ptg);
Ptg[] getFormulaTokens(EvaluationCell cell);
/**
* Find and return user defined function (UDF) contained by workbook with
* specified name.
*
* @param functionName UDF name
* @return instance of FreeRefFunction or null if no UDF with the specified
* name exists.
*/
FreeRefFunction findUserDefinedFunction(String functionName);
class ExternalSheet {
private final String _workbookName;
private final String _sheetName;

5
src/java/org/apache/poi/ss/formula/OperationEvaluationContext.java
View File

@ -22,6 +22,7 @@ import org.apache.poi.hssf.record.formula.eval.AreaEval;
import org.apache.poi.hssf.record.formula.eval.ErrorEval;
import org.apache.poi.hssf.record.formula.eval.RefEval;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.ss.SpreadsheetVersion;
import org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException;
import org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet;
@ -256,4 +257,8 @@ public final class OperationEvaluationContext {
}
return CellReference.classifyCellReference(str, ssVersion);
}
public FreeRefFunction findUserDefinedFunction(String functionName) {
return _bookEvaluator.findUserDefinedFunction(functionName);
}
}

16
src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
View File

@ -59,6 +59,8 @@ import org.apache.poi.hssf.record.formula.eval.OperationEval;
import org.apache.poi.hssf.record.formula.eval.RefEval;
import org.apache.poi.hssf.record.formula.eval.StringEval;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.hssf.util.CellReference;
import org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException;
import org.apache.poi.ss.formula.eval.NotImplementedException;
@ -87,12 +89,16 @@ public final class WorkbookEvaluator {
private final Map<String, Integer> _sheetIndexesByName;
private CollaboratingWorkbooksEnvironment _collaboratingWorkbookEnvironment;
private final IStabilityClassifier _stabilityClassifier;
private final UDFFinder _udfFinder;
public WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier) {
this (workbook, null, stabilityClassifier);
/**
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
*/
public WorkbookEvaluator(EvaluationWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
this (workbook, null, stabilityClassifier, udfFinder);
}
/* package */ WorkbookEvaluator(EvaluationWorkbook workbook, IEvaluationListener evaluationListener,
IStabilityClassifier stabilityClassifier) {
IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
_workbook = workbook;
_evaluationListener = evaluationListener;
_cache = new EvaluationCache(evaluationListener);
@ -101,6 +107,7 @@ public final class WorkbookEvaluator {
_collaboratingWorkbookEnvironment = CollaboratingWorkbooksEnvironment.EMPTY;
_workbookIx = 0;
_stabilityClassifier = stabilityClassifier;
_udfFinder = udfFinder == null ? UDFFinder.DEFAULT : udfFinder;
}
/**
@ -516,4 +523,7 @@ public final class WorkbookEvaluator {
EvaluationCell cell = sheet.getCell(rowIndex, columnIndex);
return evaluateAny(cell, sheetIndex, rowIndex, columnIndex, tracker);
}
public FreeRefFunction findUserDefinedFunction(String functionName) {
return _udfFinder.findFunction(functionName);
}
}

6
src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
View File

@ -36,8 +36,6 @@ import org.apache.poi.ss.usermodel.Workbook;
* updated after a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
*
* @author Josh Micich
*
* Modified 09/07/09 by Petr Udalau - added methods for searching for UDFs of this Workbook.
*/
final class ForkedEvaluationWorkbook implements EvaluationWorkbook {
@ -144,8 +142,4 @@ final class ForkedEvaluationWorkbook implements EvaluationWorkbook {
return _index - o._index;
}
}
public FreeRefFunction findUserDefinedFunction(String functionName) {
return _masterBook.findUserDefinedFunction(functionName);
}
}

16
src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
View File

@ -22,6 +22,7 @@ import org.apache.poi.hssf.record.formula.eval.ErrorEval;
import org.apache.poi.hssf.record.formula.eval.NumberEval;
import org.apache.poi.hssf.record.formula.eval.StringEval;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFEvaluationWorkbook;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
@ -47,9 +48,9 @@ public final class ForkedEvaluator {
private WorkbookEvaluator _evaluator;
private ForkedEvaluationWorkbook _sewb;
private ForkedEvaluator(EvaluationWorkbook masterWorkbook, IStabilityClassifier stabilityClassifier) {
private ForkedEvaluator(EvaluationWorkbook masterWorkbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
_sewb = new ForkedEvaluationWorkbook(masterWorkbook);
_evaluator = new WorkbookEvaluator(_sewb, stabilityClassifier);
_evaluator = new WorkbookEvaluator(_sewb, stabilityClassifier, udfFinder);
}
private static EvaluationWorkbook createEvaluationWorkbook(Workbook wb) {
if (wb instanceof HSSFWorkbook) {
@ -61,8 +62,17 @@ public final class ForkedEvaluator {
// }
throw new IllegalArgumentException("Unexpected workbook type (" + wb.getClass().getName() + ")");
}
/**
* @deprecated (Sep 2009) (reduce overloading) use {@link #create(Workbook, IStabilityClassifier, UDFFinder)}
*/
public static ForkedEvaluator create(Workbook wb, IStabilityClassifier stabilityClassifier) {
return new ForkedEvaluator(createEvaluationWorkbook(wb), stabilityClassifier);
return create(wb, stabilityClassifier, null);
}
/**
* @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
*/
public static ForkedEvaluator create(Workbook wb, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
return new ForkedEvaluator(createEvaluationWorkbook(wb), stabilityClassifier, udfFinder);
}
/**

2
src/java/org/apache/poi/ss/usermodel/Name.java
View File

@ -49,8 +49,6 @@ package org.apache.poi.ss.usermodel;
* name.setRefersToFormula("IF(Loan_Amount*Interest_Rate>0,1,0)");
*
* </blockquote></pre>
*
* Modified 8/31/09 by Petr Udalau - added method setFunction(boolean)
*/
public interface Name {

28
src/java/org/apache/poi/ss/usermodel/Workbook.java
View File

@ -21,15 +21,12 @@ import java.io.IOException;
import java.io.OutputStream;
import java.util.List;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
/**
* High level representation of a Excel workbook. This is the first object most users
* will construct whether they are reading or writing a workbook. It is also the
* top level object for creating new sheets/etc.
*
* Modified 09/07/09 by Petr Udalau - added methods for work with UDFs of this Workbook.
*/
public interface Workbook {
@ -467,29 +464,4 @@ public interface Workbook {
* @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
*/
void setSheetHidden(int sheetIx, int hidden);
/**
* Find and return user defined function (UDF) with specified name.
*
* @param functionName
* UDF name
* @return instance of FreeRefFunction or null if no UDF with the specified
* name exists.
*/
FreeRefFunction getUserDefinedFunction(String functionName);
/**
* Add user defined function (UDF) to workbook
*
* @param name
* @param function
*/
void registerUserDefinedFunction(String name, FreeRefFunction function);
/**
* Returns user defined functions (UDF) names
*
* @return list of UDF names
*/
List<String> getUserDefinedFunctionNames();
}

7
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java
View File

@ -20,7 +20,6 @@ package org.apache.poi.xssf.usermodel;
import org.apache.poi.hssf.record.formula.NamePtg;
import org.apache.poi.hssf.record.formula.NameXPtg;
import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.*;
import org.apache.poi.ss.SpreadsheetVersion;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDefinedName;
@ -29,8 +28,6 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDefinedName;
* Internal POI use only
*
* @author Josh Micich
*
* Modified 09/07/09 by Petr Udalau - added methods for searching for UDFs of this Workbook.
*/
public final class XSSFEvaluationWorkbook implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook {
@ -180,8 +177,4 @@ public final class XSSFEvaluationWorkbook implements FormulaRenderingWorkbook, E
public SpreadsheetVersion getSpreadsheetVersion(){
return SpreadsheetVersion.EXCEL2007;
}
public FreeRefFunction findUserDefinedFunction(String functionName) {
return _uBook.getUserDefinedFunction(functionName);
}
}

21
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java
View File

@ -24,6 +24,8 @@ import org.apache.poi.hssf.record.formula.eval.ErrorEval;
import org.apache.poi.hssf.record.formula.eval.NumberEval;
import org.apache.poi.hssf.record.formula.eval.StringEval;
import org.apache.poi.hssf.record.formula.eval.ValueEval;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.formula.IStabilityClassifier;
import org.apache.poi.ss.formula.WorkbookEvaluator;
import org.apache.poi.ss.usermodel.Cell;
@ -47,16 +49,31 @@ public class XSSFFormulaEvaluator implements FormulaEvaluator {
private WorkbookEvaluator _bookEvaluator;
public XSSFFormulaEvaluator(XSSFWorkbook workbook) {
this(workbook, null);
this(workbook, null, null);
}
/**
* @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.
* @deprecated (Sep 2009) (reduce overloading) use {@link #create(HSSFWorkbook, IStabilityClassifier, UDFFinder)}
*/
public XSSFFormulaEvaluator(XSSFWorkbook workbook, IStabilityClassifier stabilityClassifier) {
_bookEvaluator = new WorkbookEvaluator(XSSFEvaluationWorkbook.create(workbook), stabilityClassifier);
_bookEvaluator = new WorkbookEvaluator(XSSFEvaluationWorkbook.create(workbook), stabilityClassifier, null);
}
private XSSFFormulaEvaluator(XSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
_bookEvaluator = new WorkbookEvaluator(XSSFEvaluationWorkbook.create(workbook), stabilityClassifier, udfFinder);
}
/**
* @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 XSSFFormulaEvaluator create(XSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) {
return new XSSFFormulaEvaluator(workbook, stabilityClassifier, udfFinder);
}
/**
* Should be called whenever there are major changes (e.g. moving sheets) to input cells

26
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
View File

@ -32,7 +32,6 @@ import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLProperties;
import org.apache.poi.hssf.record.formula.SheetNameFormatter;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart;
@ -41,7 +40,6 @@ import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.openxml4j.opc.PackageRelationshipTypes;
import org.apache.poi.openxml4j.opc.PackagingURIHelper;
import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
@ -65,8 +63,6 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.*;
* High level representation of a SpreadsheetML workbook. This is the first object most users
* will construct whether they are reading or writing a workbook. It is also the
* top level object for creating new sheets/etc.
*
* Modified 09/07/09 by Petr Udalau - added methods for work with UDFs of this Workbook.
*/
public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<XSSFSheet> {
private static final Pattern COMMA_PATTERN = Pattern.compile(",");
@ -134,9 +130,6 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
private static POILogger logger = POILogFactory.getLogger(XSSFWorkbook.class);
/** Map of user defined functions, key - function name, value - instance of FreeRefFunctions */
private Map<String, FreeRefFunction> udfFunctions = new HashMap<String, FreeRefFunction>();
/**
* Create a new SpreadsheetML workbook.
*/
@ -1352,23 +1345,4 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
public MapInfo getMapInfo(){
return mapInfo;
}
public FreeRefFunction getUserDefinedFunction(String functionName) {
return udfFunctions.get(functionName);
}
public void registerUserDefinedFunction(String functionName, FreeRefFunction freeRefFunction) {
Name udfDeclaration = getName(functionName);
if (udfDeclaration == null) {
udfDeclaration = createName();
}
udfDeclaration.setNameName(functionName);
udfDeclaration.setFunction(true);
udfFunctions.put(functionName, freeRefFunction);
}
public List<String> getUserDefinedFunctionNames() {
return new ArrayList<String>(udfFunctions.keySet());
}
}

70
src/testcases/org/apache/poi/hssf/record/formula/eval/TestExternalFunction.java
View File

@ -17,97 +17,79 @@
package org.apache.poi.hssf.record.formula.eval;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.hssf.record.formula.functions.FreeRefFunction;
import org.apache.poi.hssf.record.formula.toolpack.DefaultToolPack;
import org.apache.poi.hssf.record.formula.toolpack.MainToolPacksHandler;
import org.apache.poi.hssf.record.formula.toolpack.ToolPack;
import org.apache.poi.hssf.record.formula.udf.DefaultUDFFinder;
import org.apache.poi.hssf.record.formula.udf.AggregatingUDFFinder;
import org.apache.poi.hssf.record.formula.udf.UDFFinder;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.usermodel.Workbook;
/**
*
* @author Josh Micich
*
* Modified 09/14/09 by Petr Udalau - Test of registering UDFs in workbook and
* using ToolPacks.
* @author Petr Udalau - registering UDFs in workbook and using ToolPacks.
*/
public final class TestExternalFunction extends TestCase {
private static class MyFunc implements FreeRefFunction {
public MyFunc() {
//
}
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
if (args.length != 1 || !(args[0] instanceof StringEval)) {
return ErrorEval.VALUE_INVALID;
} else {
}
StringEval input = (StringEval) args[0];
return new StringEval(input.getStringValue() + "abc");
}
}
}
private static class MyFunc2 implements FreeRefFunction {
public MyFunc2() {
//
}
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
if (args.length != 1 || !(args[0] instanceof StringEval)) {
return ErrorEval.VALUE_INVALID;
} else {
}
StringEval input = (StringEval) args[0];
return new StringEval(input.getStringValue() + "abc2");
}
}
}
/**
* Creates and registers user-defined function "MyFunc()" directly with POI.
* This is VB function defined in "testNames.xls". In future there must be
* some parser of VBA scripts which will register UDFs.
*/
private void registerMyFunc(Workbook workbook) {
workbook.registerUserDefinedFunction("myFunc", new MyFunc());
}
/**
* Creates example ToolPack which contains function "MyFunc2()".
*/
private void createExampleToolPack() {
ToolPack exampleToolPack = new DefaultToolPack();
exampleToolPack.addFunction("myFunc2", new MyFunc2());
MainToolPacksHandler.instance().addToolPack(exampleToolPack);
}
/**
* Checks that an external function can get invoked from the formula
* evaluator.
*
* @throws IOException
*
*/
public void testInvoke() {
HSSFWorkbook wb = HSSFTestDataSamples.openSampleWorkbook("testNames.xls");
HSSFSheet sheet = wb.getSheetAt(0);
registerMyFunc(wb);
createExampleToolPack();
/**
* register the two test UDFs in a UDF finder, to be passed to the evaluator
*/
UDFFinder udff1 = new DefaultUDFFinder(new String[] { "myFunc", },
new FreeRefFunction[] { new MyFunc(), });
UDFFinder udff2 = new DefaultUDFFinder(new String[] { "myFunc2", },
new FreeRefFunction[] { new MyFunc2(), });
UDFFinder udff = new AggregatingUDFFinder(udff1, udff2);
HSSFRow row = sheet.getRow(0);
HSSFCell myFuncCell = row.getCell(1); //=myFunc("_")
HSSFCell myFuncCell = row.getCell(1); // =myFunc("_")
HSSFCell myFunc2Cell = row.getCell(2); //=myFunc2("_")
HSSFCell myFunc2Cell = row.getCell(2); // =myFunc2("_")
HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
try {
HSSFFormulaEvaluator fe = HSSFFormulaEvaluator.create(wb, null, udff);
assertEquals("_abc", fe.evaluate(myFuncCell).getStringValue());
assertEquals("_abc2", fe.evaluate(myFunc2Cell).getStringValue());
} catch (Exception e) {
assertFalse(true);
}
}
}

2
src/testcases/org/apache/poi/ss/formula/TestWorkbookEvaluator.java
View File

@ -44,7 +44,7 @@ public class TestWorkbookEvaluator extends TestCase {
private static ValueEval evaluateFormula(Ptg[] ptgs) {
OperationEvaluationContext ec = new OperationEvaluationContext(null, null, 0, 0, 0, null);
return new WorkbookEvaluator(null, null).evaluateFormula(ec, ptgs);
return new WorkbookEvaluator(null, null, null).evaluateFormula(ec, ptgs);
}
/**

2
src/testcases/org/apache/poi/ss/formula/WorkbookEvaluatorTestHelper.java
View File

@ -32,6 +32,6 @@ public final class WorkbookEvaluatorTestHelper {
}
public static WorkbookEvaluator createEvaluator(HSSFWorkbook wb, EvaluationListener listener) {
return new WorkbookEvaluator(HSSFEvaluationWorkbook.create(wb), listener, null);
return new WorkbookEvaluator(HSSFEvaluationWorkbook.create(wb), listener, null, null);
}
}