Page History

package com.fr.script;

import com.fr.common.annotations.Open;
import com.fr.locale.InterProviderFactory;
import com.fr.stable.Primitive;
import com.fr.stable.UtilEvalError;
import com.fr.stable.exception.FormulaException;
import com.fr.stable.script.Node;

/**
 * 内置函数/自定义函数的抽象实现类.
 *
 * @author richie
 * created on 2020-09-04
 */
@Open
public abstract class AbstractFunction extends CalculatorEmbeddedFunction {

    /**
     * 通过指定的参数，计算函数的结果.
     *
     * @param arguments 参数列表
     * @return 函数的结果
     * @throws UtilEvalError 如果在计算中出现无法解析的值，则抛出此异常
     */
    @Override
    public Object evalExpression(Node[] arguments) throws UtilEvalError {

        Object returnValue;
        if (this.getType() == HA) {
            //层次坐标系列的不在这边eval
            returnValue = tryRun(arguments);
        } else {
            Object[] args = new Object[arguments.length];
            for (int i = 0; i < arguments.length; i++) {
                args[i] = this.getCalculatorProvider().evalValue(arguments[i]);
            }
            returnValue = tryRun(args);
        }

        if (returnValue == Primitive.ERROR_VALUE || returnValue == Primitive.ERROR_NAME) {
            log(InterProviderFactory.getProvider().getLocText("Fine-Core_Base_NS_Cell_Formula") + toString());
        }

        return returnValue;
    }

    /**
     * 获取函数所使用的算子.
     *
     * @return 算子
     */
    @Deprecated
    public Calculator getCalculator() {
        return (Calculator) getCalculatorProvider();
    }

    private Object tryRun(Object[] args) throws UtilEvalError {

        try {
            return run(args);
        } catch (FormulaException fe) {
            throw new UtilEvalError(fe);
        }
    }

    /**
     * 计算函数的结果.
     *
     * @param args 函数的参数，是经过了算子处理了其中特殊参数的
     * @return 函数的结果
     * @throws FormulaException 函数计算过程中抛出的异常
     */
    public abstract Object run(Object[] args) throws FormulaException;


}

<extra-core>
	<!-- 注册一组函数的方法 -->
    <FunctionGroup class="your class name"/>
	<!-- 注册单个函数的方法 -->
	<FunctionDefineProvider class="your class name"
                                name="函数名" description="函数的用法介绍"/>
</extra-core>