123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244 |
- /*
- * ==================================================================== 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.atp;
-
- import org.apache.poi.ss.formula.OperationEvaluationContext;
- import org.apache.poi.ss.formula.eval.NotImplementedException;
- 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.*;
- import org.apache.poi.ss.formula.udf.UDFFinder;
-
- import java.util.*;
-
- /**
- * Analysis Toolpack Function Definitions
- */
- public final class AnalysisToolPak implements UDFFinder {
-
- public static final UDFFinder instance = new AnalysisToolPak();
-
- private static final class NotImplemented implements FreeRefFunction {
- private final String _functionName;
-
- public NotImplemented(String functionName) {
- _functionName = functionName;
- }
-
- public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
- throw new NotImplementedException(_functionName);
- }
- }
-
- private final Map<String, FreeRefFunction> _functionsByName = createFunctionsMap();
-
- private AnalysisToolPak() {
- // enforce singleton
- }
-
- public FreeRefFunction findFunction(String name) {
- // functions that are available in Excel 2007+ have a prefix _xlfn.
- // if you save such a .xlsx workbook as .xls
- if(name.startsWith("_xlfn.")) name = name.substring(6);
-
- return _functionsByName.get(name.toUpperCase());
- }
-
- private Map<String, FreeRefFunction> createFunctionsMap() {
- Map<String, FreeRefFunction> m = new HashMap<String, FreeRefFunction>(108);
-
- r(m, "ACCRINT", null);
- r(m, "ACCRINTM", null);
- r(m, "AMORDEGRC", null);
- r(m, "AMORLINC", null);
- r(m, "AVERAGEIF", null);
- r(m, "AVERAGEIFS", null);
- r(m, "BAHTTEXT", null);
- r(m, "BESSELI", null);
- r(m, "BESSELJ", null);
- r(m, "BESSELK", null);
- r(m, "BESSELY", null);
- r(m, "BIN2DEC", null);
- r(m, "BIN2HEX", null);
- r(m, "BIN2OCT", null);
- r(m, "COMPLEX", Complex.instance);
- r(m, "CONVERT", null);
- r(m, "COUNTIFS", null);
- r(m, "COUPDAYBS", null);
- r(m, "COUPDAYS", null);
- r(m, "COUPDAYSNC", null);
- r(m, "COUPNCD", null);
- r(m, "COUPNUM", null);
- r(m, "COUPPCD", null);
- r(m, "CUBEKPIMEMBER", null);
- r(m, "CUBEMEMBER", null);
- r(m, "CUBEMEMBERPROPERTY", null);
- r(m, "CUBERANKEDMEMBER", null);
- r(m, "CUBESET", null);
- r(m, "CUBESETCOUNT", null);
- r(m, "CUBEVALUE", null);
- r(m, "CUMIPMT", null);
- r(m, "CUMPRINC", null);
- r(m, "DEC2BIN", null);
- r(m, "DEC2HEX", null);
- r(m, "DEC2OCT", null);
- r(m, "DELTA", Delta.instance);
- r(m, "DISC", null);
- r(m, "DOLLARDE", null);
- r(m, "DOLLARFR", null);
- r(m, "DURATION", null);
- r(m, "EDATE", EDate.instance);
- r(m, "EFFECT", null);
- r(m, "EOMONTH", null);
- r(m, "ERF", null);
- r(m, "ERFC", null);
- r(m, "FACTDOUBLE", null);
- r(m, "FVSCHEDULE", null);
- r(m, "GCD", null);
- r(m, "GESTEP", null);
- r(m, "HEX2BIN", null);
- r(m, "HEX2DEC", null);
- r(m, "HEX2OCT", null);
- r(m, "IFERROR", IfError.instance);
- r(m, "IMABS", null);
- r(m, "IMAGINARY", Imaginary.instance);
- r(m, "IMARGUMENT", null);
- r(m, "IMCONJUGATE", null);
- r(m, "IMCOS", null);
- r(m, "IMDIV", null);
- r(m, "IMEXP", null);
- r(m, "IMLN", null);
- r(m, "IMLOG10", null);
- r(m, "IMLOG2", null);
- r(m, "IMPOWER", null);
- r(m, "IMPRODUCT", null);
- r(m, "IMREAL", ImReal.instance);
- r(m, "IMSIN", null);
- r(m, "IMSQRT", null);
- r(m, "IMSUB", null);
- r(m, "IMSUM", null);
- r(m, "INTRATE", null);
- r(m, "ISEVEN", ParityFunction.IS_EVEN);
- r(m, "ISODD", ParityFunction.IS_ODD);
- r(m, "JIS", null);
- r(m, "LCM", null);
- r(m, "MDURATION", null);
- r(m, "MROUND", MRound.instance);
- r(m, "MULTINOMIAL", null);
- r(m, "NETWORKDAYS", NetworkdaysFunction.instance);
- r(m, "NOMINAL", null);
- r(m, "OCT2BIN", null);
- r(m, "OCT2DEC", null);
- r(m, "OCT2HEX", null);
- r(m, "ODDFPRICE", null);
- r(m, "ODDFYIELD", null);
- r(m, "ODDLPRICE", null);
- r(m, "ODDLYIELD", null);
- r(m, "PRICE", null);
- r(m, "PRICEDISC", null);
- r(m, "PRICEMAT", null);
- r(m, "QUOTIENT", Quotient.instance);
- r(m, "RANDBETWEEN", RandBetween.instance);
- r(m, "RECEIVED", null);
- r(m, "RTD", null);
- r(m, "SERIESSUM", null);
- r(m, "SQRTPI", null);
- r(m, "SUMIFS", Sumifs.instance);
- r(m, "TBILLEQ", null);
- r(m, "TBILLPRICE", null);
- r(m, "TBILLYIELD", null);
- r(m, "WEEKNUM", WeekNum.instance);
- r(m, "WORKDAY", WorkdayFunction.instance);
- r(m, "XIRR", null);
- r(m, "XNPV", null);
- r(m, "YEARFRAC", YearFrac.instance);
- r(m, "YIELD", null);
- r(m, "YIELDDISC", null);
- r(m, "YIELDMAT", null);
-
- return m;
- }
-
- private static void r(Map<String, FreeRefFunction> m, String functionName, FreeRefFunction pFunc) {
- 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 a collection of ATP function names implemented by POI.
- *
- * @return an array of supported functions
- * @since 3.8 beta6
- */
- public static Collection<String> getSupportedFunctionNames(){
- AnalysisToolPak inst = (AnalysisToolPak)instance;
- Collection<String> lst = new TreeSet<String>();
- for(String name : inst._functionsByName.keySet()){
- FreeRefFunction func = inst._functionsByName.get(name);
- if(func != null && !(func instanceof NotImplemented)){
- lst.add(name);
- }
- }
- return Collections.unmodifiableCollection(lst);
- }
-
- /**
- * Returns a collection of ATP function names NOT implemented by POI.
- *
- * @return an array of not supported functions
- * @since 3.8 beta6
- */
- public static Collection<String> getNotSupportedFunctionNames(){
- AnalysisToolPak inst = (AnalysisToolPak)instance;
- Collection<String> lst = new TreeSet<String>();
- for(String name : inst._functionsByName.keySet()){
- FreeRefFunction func = inst._functionsByName.get(name);
- if(func != null && (func instanceof NotImplemented)){
- lst.add(name);
- }
- }
- return Collections.unmodifiableCollection(lst);
- }
-
- /**
- * 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.");
- }
-
- 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);
- }
- }
|