pashko/apache-poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2026-02-27 20:40:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

allow ATP function override

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1925442 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2025-05-06 20:29:55 +00:00
parent a56b68476f
commit cdcc14d6e3
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
View File

@ -17,6 +17,8 @@ import java.util.Locale;
import java.util.Map;
import java.util.TreeSet;
import org.apache.logging.log4j.Logger;
import org.apache.poi.logging.PoiLogManager;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.NotImplementedFunctionException;
import org.apache.poi.ss.formula.eval.ValueEval;
@ -32,6 +34,8 @@ public final class AnalysisToolPak implements UDFFinder {
public static final UDFFinder instance = new AnalysisToolPak();
private static final Logger LOG = PoiLogManager.getLogger(AnalysisToolPak.class);
private static final class NotImplemented implements FreeRefFunction {
private final String _functionName;
@ -264,11 +268,28 @@ public final class AnalysisToolPak implements UDFFinder {
* @param name the function name
* @param func the function to register
* @throws IllegalArgumentException if the function is unknown or already registered.
* @since 3.8 beta6
* @since since 3.8 beta6
*/
public static void registerFunction(String name, FreeRefFunction func) {
registerFunction(name, func, false);
}
/**
* Register an ATP function in runtime.
*
* @param name the function name
* @param func the function to register
* @param force force registration even if the function is already registered or unknown to POI
* @throws IllegalArgumentException if the function is unknown or already registered (and `force` is not true).
* @since POI 5.4.2
*/
public static void registerFunction(String name, FreeRefFunction func, boolean force) {
AnalysisToolPak inst = (AnalysisToolPak)instance;
if(!isATPFunction(name)) {
if (force) {
// Excel regularly adds new functions, so the ones registered in POI
// can be well out of date - allow users who know what they are doing
// to force their update
} else if(!isATPFunction(name)) {
FunctionMetadata metaData = FunctionMetadataRegistry.getFunctionByName(name);
if(metaData != null) {
throw new IllegalArgumentException(name + " is a built-in Excel function. " +
@ -277,13 +298,20 @@ public final class AnalysisToolPak implements UDFFinder {
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 implements " + name +
". You cannot override POI's implementations of Excel functions");
if (force) {
LOG.info("POI already implements " + name +
". You are overriding the implementation.");
} else {
throw new IllegalArgumentException("POI already implements " + name +
". You cannot override POI's implementations of Excel functions");
}
}
// FIXME: inconsistent case-sensitivity
inst._functionsByName.put(name, func);
}
}