From 946733c773dd9520c2c8fd5ce48438a754b109e0 Mon Sep 17 00:00:00 2001 From: Yegor Kozlov Date: Tue, 21 Feb 2012 09:43:01 +0000 Subject: [PATCH] allow runtime registration of functions in FormulaEvaluator git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1291677 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/status.xml | 1 + .../poi/ss/formula/atp/AnalysisToolPak.java | 56 ++++++++ .../poi/ss/formula/eval/FunctionEval.java | 49 +++++++ .../poi/ss/formula/TestFunctionRegistry.java | 136 ++++++++++++++++++ 4 files changed, 242 insertions(+) create mode 100644 src/testcases/org/apache/poi/ss/formula/TestFunctionRegistry.java diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index 31402b1482..edfd430e92 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -34,6 +34,7 @@ + allow runtime registration of functions in FormulaEvaluator 52665 - When reading from a ZipFileZipEntrySource that has already been closed, give IllegalArgumentException rather than NPE 52664 - MAPIMessage may not always have name chunks when checking for 7 bit encodings 52649 - fixed namespace issue in WordToFoConverter diff --git a/src/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java b/src/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java index ce93467ad7..098ad996e9 100644 --- a/src/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java +++ b/src/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java @@ -10,11 +10,16 @@ package org.apache.poi.ss.formula.atp; +import java.util.ArrayList; import java.util.HashMap; import java.util.Map; import org.apache.poi.ss.formula.eval.ValueEval; +import org.apache.poi.ss.formula.function.FunctionMetadata; +import org.apache.poi.ss.formula.function.FunctionMetadataRegistry; import org.apache.poi.ss.formula.functions.FreeRefFunction; +import org.apache.poi.ss.formula.functions.Function; +import org.apache.poi.ss.formula.functions.NotImplementedFunction; import org.apache.poi.ss.formula.functions.Sumifs; import org.apache.poi.ss.formula.udf.UDFFinder; import org.apache.poi.ss.formula.OperationEvaluationContext; @@ -175,4 +180,55 @@ public final class AnalysisToolPak implements UDFFinder { FreeRefFunction func = pFunc == null ? new NotImplemented(functionName) : pFunc; m.put(functionName, func); } + + public static boolean isATPFunction(String name){ + AnalysisToolPak inst = (AnalysisToolPak)instance; + return inst._functionsByName.containsKey(name); + } + + /** + * Returns an array of function names implemented by POI. + * + * @return an array of supported functions + * @since 3.8 beta6 + */ + public static String[] getSupportedFunctionNames(){ + AnalysisToolPak inst = (AnalysisToolPak)instance; + ArrayList lst = new ArrayList(); + for(String name : inst._functionsByName.keySet()){ + FreeRefFunction func = inst._functionsByName.get(name); + if(func != null && !(func instanceof NotImplemented)){ + lst.add(name); + } + } + return lst.toArray(new String[lst.size()]); + } + + /** + * Register a ATP function in runtime. + * + * @param name the function name + * @param func the functoin to register + * @throws IllegalArgumentException if the function is unknown or already registered. + * @since 3.8 beta6 + */ + public static void registerFunction(String name, FreeRefFunction func){ + AnalysisToolPak inst = (AnalysisToolPak)instance; + if(!isATPFunction(name)) { + FunctionMetadata metaData = FunctionMetadataRegistry.getFunctionByName(name); + if(metaData != null) { + throw new IllegalArgumentException(name + " is a built-in Excel function. " + + "Use FunctoinEval.registerFunction(String name, Function func) instead."); + } else { + throw new IllegalArgumentException(name + " is not a function from the Excel Analysis Toolpack."); + } + } + FreeRefFunction f = inst.findFunction(name); + if(f != null && !(f instanceof NotImplemented)) { + throw new IllegalArgumentException("POI already implememts " + name + + ". You cannot override POI's implementations of Excel functions"); + } + + inst._functionsByName.put(name, func); + } } diff --git a/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java b/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java index b3a18c1a14..980d8af745 100644 --- a/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java +++ b/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java @@ -17,10 +17,13 @@ package org.apache.poi.ss.formula.eval; +import org.apache.poi.ss.formula.atp.AnalysisToolPak; import org.apache.poi.ss.formula.function.FunctionMetadata; import org.apache.poi.ss.formula.function.FunctionMetadataRegistry; import org.apache.poi.ss.formula.functions.*; +import java.util.ArrayList; + /** * @author Amol S. Deshmukh < amolweb at ya hoo dot com > */ @@ -255,4 +258,50 @@ public final class FunctionEval { } return result; } + + /** + * Register a new function in runtime. + * + * @param name the function name + * @param func the functoin to register + * @throws IllegalArgumentException if the function is unknown or already registered. + * @since 3.8 beta6 + */ + public static void registerFunction(String name, Function func){ + FunctionMetadata metaData = FunctionMetadataRegistry.getFunctionByName(name); + if(metaData == null) { + if(AnalysisToolPak.isATPFunction(name)) { + throw new IllegalArgumentException(name + " is a function from the Excel Analysis Toolpack. " + + "Use AnalysisToolpack.registerFunction(String name, FreeRefFunction func) instead."); + } else { + throw new IllegalArgumentException("Unknown function: " + name); + } + } + + int idx = metaData.getIndex(); + if(functions[idx] instanceof NotImplementedFunction) { + functions[idx] = func; + } else { + throw new IllegalArgumentException("POI already implememts " + name + + ". You cannot override POI's implementations of Excel functions"); + } + } + + /** + * Returns an array of function names implemented by POI. + * + * @return an array of supported functions + * @since 3.8 beta6 + */ + public static String[] getSupportedFunctionNames(){ + ArrayList lst = new ArrayList(); + for(int i = 0; i < functions.length; i++){ + Function func = functions[i]; + if(func != null && !(func instanceof NotImplementedFunction)){ + FunctionMetadata metaData = FunctionMetadataRegistry.getFunctionByIndex(i); + lst.add(metaData.getName()); + } + } + return lst.toArray(new String[lst.size()]); + } } diff --git a/src/testcases/org/apache/poi/ss/formula/TestFunctionRegistry.java b/src/testcases/org/apache/poi/ss/formula/TestFunctionRegistry.java new file mode 100644 index 0000000000..87f07ce69d --- /dev/null +++ b/src/testcases/org/apache/poi/ss/formula/TestFunctionRegistry.java @@ -0,0 +1,136 @@ +/* + * ==================================================================== + * 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.ss.formula; + +import junit.framework.TestCase; +import org.apache.poi.hssf.usermodel.*; +import org.apache.poi.ss.formula.atp.AnalysisToolPak; +import org.apache.poi.ss.formula.eval.ErrorEval; +import org.apache.poi.ss.formula.eval.FunctionEval; +import org.apache.poi.ss.formula.eval.NotImplementedException; +import org.apache.poi.ss.formula.eval.ValueEval; +import org.apache.poi.ss.formula.functions.FreeRefFunction; +import org.apache.poi.ss.formula.functions.Function; +import org.apache.poi.ss.usermodel.CellValue; + +/** + * + * @author Yegor Kozlov + */ +public class TestFunctionRegistry extends TestCase { + + public void testRegisterInRuntime() { + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet("Sheet1"); + HSSFRow row = sheet.createRow(0); + HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb); + + HSSFCell cellA = row.createCell(0); + cellA.setCellFormula("FISHER(A5)"); + CellValue cv; + try { + cv = fe.evaluate(cellA); + fail("expectecd exception"); + } catch (NotImplementedException e) { + ; + } + + FunctionEval.registerFunction("FISHER", new Function() { + public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex) { + return ErrorEval.NA; + } + }); + + cv = fe.evaluate(cellA); + assertEquals(ErrorEval.NA.getErrorCode(), cv.getErrorValue()); + + HSSFCell cellB = row.createCell(1); + cellB.setCellFormula("CUBEMEMBERPROPERTY(A5)"); + try { + cv = fe.evaluate(cellB); + fail("expectecd exception"); + } catch (NotImplementedException e) { + ; + } + + AnalysisToolPak.registerFunction("CUBEMEMBERPROPERTY", new FreeRefFunction() { + public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) { + return ErrorEval.NUM_ERROR; + } + }); + + cv = fe.evaluate(cellB); + assertEquals(ErrorEval.NUM_ERROR.getErrorCode(), cv.getErrorValue()); + } + + public void testExceptions() { + Function func = new Function() { + public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex) { + return ErrorEval.NA; + } + }; + try { + FunctionEval.registerFunction("SUM", func); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("POI already implememts SUM" + + ". You cannot override POI's implementations of Excel functions", e.getMessage()); + } + try { + FunctionEval.registerFunction("SUMXXX", func); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("Unknown function: SUMXXX", e.getMessage()); + } + try { + FunctionEval.registerFunction("ISODD", func); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("ISODD is a function from the Excel Analysis Toolpack. " + + "Use AnalysisToolpack.registerFunction(String name, FreeRefFunction func) instead.", e.getMessage()); + } + + FreeRefFunction atpFunc = new FreeRefFunction() { + public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) { + return ErrorEval.NUM_ERROR; + } + }; + try { + AnalysisToolPak.registerFunction("ISODD", atpFunc); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("POI already implememts ISODD" + + ". You cannot override POI's implementations of Excel functions", e.getMessage()); + } + try { + AnalysisToolPak.registerFunction("ISODDXXX", atpFunc); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("ISODDXXX is not a function from the Excel Analysis Toolpack.", e.getMessage()); + } + try { + AnalysisToolPak.registerFunction("SUM", atpFunc); + fail("expectecd exception"); + } catch (IllegalArgumentException e){ + assertEquals("SUM is a built-in Excel function. " + + "Use FunctoinEval.registerFunction(String name, Function func) instead.", e.getMessage()); + } + } +} -- 2.39.5