Calculator

java.lang.Object
- com.fr.script.Calculator

所有已实现的接口:

Context, CalculatorProvider, java.io.Serializable, java.lang.Cloneable
```
public final class Calculator
extends java.lang.Object
implements CalculatorProvider, java.io.Serializable, java.lang.Cloneable
```
算子类，该类用于处理各种公式运算

另请参阅:
序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class Calculator.NameSpaceChain

嵌套类
限定符和类型	类和说明
`protected static class`	`Calculator.NameSpaceChain`

字段概要

字段
限定符和类型字段和说明

static CalculatorKey SHEET_NUMBER_KEY
- 从接口继承的字段 com.fr.stable.script.CalculatorProvider
  CONTEXT_PATH, ENV_HOME, FORMLET_NAME, FR_HOME, PROJECTNAME, REMOTE_SERVLET_URL, REPORT_NAME, SERVER_NAME, SERVER_PORT, SERVER_SCHEMA, SERVER_URL, SERVLET_URL, SESSION_HEART_BEAT, SESSION_ID

字段
限定符和类型	字段和说明
`static CalculatorKey`	`SHEET_NUMBER_KEY`

方法概要

方法
限定符和类型	方法和说明
`static void`	`clearThreadSavedParameter()` 清楚所有的保存的线程信息
`static Calculator`	`createCalculator()` alex:返回当前线程正在用的Calculator 一个线程只用一个Calculator,至少线程内的环境在这个Calculator里面共享不知道会不会有问题,会不会有可能只需要局部的Calculator
`java.lang.Object`	`eval(FormulaProvider obj)` 计算给定的公式的值计算一个公式得到结果： Calculator ca = Calculator.createCalculator(); System.out.println(ca.eval(new Formula("1 + 2 * 3")));
`java.lang.Object`	`eval(Node obj)` 计算给定的函数节点的值
`java.lang.Object`	`eval(java.lang.String obj)` 根据obj的类型判断计算方式如果是单元格，默认计算出来就是单元格，不会取值
`java.lang.Object`	`evalAuth()`
`java.lang.Object`	`evalValue(FormulaProvider obj)` 计算给定公式的结果并使用转换器转换结算结果
`java.lang.Object`	`evalValue(Node obj)` 计算给定的函数节点并使用转换器转换结算结果
`java.lang.Object`	`evalValue(java.lang.String obj)` 计算给定表达式的结果并使用转换器转换结算结果
`java.lang.String`	`exStatement(ColumnRow currentColumnRow, java.lang.String statement)` 解析表达式
`<T> T`	`getAttribute(CalculatorKey key)` 根据指定的属性名获取保存在算子中的属性值
`<T> T`	`getAttribute(java.lang.Class clazz)`
`java.sql.Connection`	`getConnection(java.lang.String name)`
`ColumnRow`	`getCurrentColumnRow()` 获取在计算中正在使用的格子
`ColumnRow`	`getCurrentFromColumnRow()` 已过时。
`CalculateLocator`	`getLocator()` 获取计算坐标系
`java.util.LinkedList`	`getNameSpaceList()`
`static NameSpace`	`getSavedSessionNameSpace()`
`static java.util.Map<java.lang.String,java.lang.Object>`	`getSavedVariables()`
`java.lang.String`	`onAddDeleteColumnOrRow(java.lang.String statement, int rowIndex, int rowChanged, int columnIndex, int colChanged)` alex: 当行列添加时
`Expression`	`parse(java.lang.Object o)` 将一个对象解析成函数表达式
`Expression`	`parse(java.lang.String statement)` 将字符串解析成函数表达式
`static ParameterProvider[]`	`processParameters(CalculatorProvider calculator, ParameterProvider[] parameters)` 处理参数，将参数值中的公式使用算子做解析得出结果
`void`	`pushNameSpace(NameSpace ns)` 将一个名字空间添加到全局名字空间链的头部添加名字空间（参数名字空间），并根据他计算出结果的例子，计算结果是5： Calculator ca = Calculator.createCalculator(); Map map = new HashMap(); map.put("p1", 2); ParameterMapNameSpace space = ParameterMapNameSpace.create(map); ca.pushNameSpace(space); System.out.println(ca.eval(new Formula("$p1 + 3")));
`void`	`putConnection(java.lang.String name, java.sql.Connection conn)` 添加连接
`static void`	`putThreadSavedNameSpace(NameSpace ns)` 添加线程NameSpace
`static ColumnRowRange[]`	`relatedColumnRowRangeArray(java.lang.String statement)` 解析表达式中相关的扩展格子下面的返回结果是A1行列和C1行列： Calculator.createCalculator().relatedColumnRowRangeArray("left(A1,2) + 'B1' + C1");
`static java.lang.String[]`	`relatedParameters(java.lang.String statement)` 解析给定的表达式中相关的参数下面的返回结果是"$C1"这个参数名： Calculator.createCalculator().relatedParameters("left(A1,2) + 'B1' + $C1");
`void`	`remove(java.lang.String name)` 在全局名字空间中移除一个值
`void`	`removeAttribute(CalculatorKey key)` 移除指定的属性
`void`	`removeConnection(java.lang.String name)` 移除连接
`boolean`	`removeNameSpace(NameSpace ns)` 从全局名字空间链上移除一个指定的名字空间
`Function`	`resolveMethod(java.lang.Object var)` 将表达式转化为一个函数并返回
`java.lang.Object`	`resolveRelateCellElements(ColumnRow cr)` 获取指定单元格的关联格子
`java.lang.Object`	`resolveVariable(java.lang.Object var)` 将给定的表达式计算出结果
`java.lang.Object`	`resolveVariableInCE(java.lang.Object var)` 在单元格范畴内计算表达式的值
`void`	`set(java.lang.String name, java.lang.Object value)` 在全局名字空间中添加一个键值对
`void`	`setAttribute(CalculatorKey key, java.lang.Object attribute)` 添加一个键值对到算子的属性表中属性不用于计算，添加属性的例子： StableFactory.registerDefaultNameSpace(DefaultNameSpace.getInstance()); Calculator ca = Calculator.createCalculator(); ca.setAttribute("p1", 2); ca.getAttribute("p1"); //结果是2 ca.eval(new Formula("$p1 + 3")); //结果是3
`void`	`setAttribute(java.lang.Class clazz, java.lang.Object attribute)` 已过时。
`void`	`setCurrentColumnRow(ColumnRow columnRow)` 已过时。
`void`	`setCurrentFromColumnRow(ColumnRow cr)` 已过时。
`static void`	`setThreadSavedParameter(java.lang.String name, java.lang.Object ob)` 保存环境变量于ThreadContext

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SHEET_NUMBER_KEY
```
public static final CalculatorKey SHEET_NUMBER_KEY
```
- 方法详细资料
  - createCalculator
```
public static Calculator createCalculator()
```
    alex:返回当前线程正在用的Calculator
    一个线程只用一个Calculator,至少线程内的环境在这个Calculator里面共享
    不知道会不会有问题,会不会有可能只需要局部的Calculator
    
    返回:
    构造的算子对象
  - putThreadSavedNameSpace
```
public static void putThreadSavedNameSpace(NameSpace ns)
```
    添加线程NameSpace
    
    参数:
    ns - 添加的NameSpace
  - setThreadSavedParameter
```
public static void setThreadSavedParameter(java.lang.String name,
                           java.lang.Object ob)
```
    保存环境变量于ThreadContext
    
    参数:
    name - 环境变量名称
    ob - 环境变量对象
  - clearThreadSavedParameter
```
public static void clearThreadSavedParameter()
```
    清楚所有的保存的线程信息
  - getSavedVariables
```
public static java.util.Map<java.lang.String,java.lang.Object> getSavedVariables()
```
  - getSavedSessionNameSpace
```
public static NameSpace getSavedSessionNameSpace()
```
  - processParameters
```
public static ParameterProvider[] processParameters(CalculatorProvider calculator,
                                    ParameterProvider[] parameters)
```
    处理参数，将参数值中的公式使用算子做解析得出结果
    
    参数:
    calculator - 算子
    parameters - 原始参数
    
    返回:
    结果参数
  - setAttribute
```
public void setAttribute(CalculatorKey key,
                java.lang.Object attribute)
```
    添加一个键值对到算子的属性表中
    属性不用于计算，添加属性的例子： StableFactory.registerDefaultNameSpace(DefaultNameSpace.getInstance()); Calculator ca = Calculator.createCalculator(); ca.setAttribute("p1", 2); ca.getAttribute("p1"); //结果是2 ca.eval(new Formula("$p1 + 3")); //结果是3
    
    指定者:
    
    setAttribute 在接口中 CalculatorProvider
    
    参数:
    key - 属性名
    attribute - 属性值
  - setAttribute
```
@Deprecated
public void setAttribute(java.lang.Class clazz,
                           java.lang.Object attribute)
```
    已过时。
    
    兼容，新开发调整禁止调用
    
    指定者:
    
    setAttribute 在接口中 CalculatorProvider
  - getAttribute
```
public <T> T getAttribute(java.lang.Class clazz)
```
    指定者:
    
    getAttribute 在接口中 CalculatorProvider
  - getAttribute
```
public <T> T getAttribute(CalculatorKey key)
```
    根据指定的属性名获取保存在算子中的属性值
    
    指定者:
    
    getAttribute 在接口中 Context
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - removeAttribute
```
public void removeAttribute(CalculatorKey key)
```
    移除指定的属性
    
    指定者:
    
    removeAttribute 在接口中 CalculatorProvider
    
    参数:
    key - 要移除的属性对应的属性名
  - set
```
public void set(java.lang.String name,
       java.lang.Object value)
```
    在全局名字空间中添加一个键值对
    
    指定者:
    
    set 在接口中 CalculatorProvider
    
    参数:
    name - 名字
    value - 值
  - remove
```
public void remove(java.lang.String name)
```
    在全局名字空间中移除一个值
    
    指定者:
    
    remove 在接口中 CalculatorProvider
    
    参数:
    name - 要移除的值的名字
  - pushNameSpace
```
public void pushNameSpace(NameSpace ns)
```
    将一个名字空间添加到全局名字空间链的头部
    添加名字空间（参数名字空间），并根据他计算出结果的例子，计算结果是5：
    Calculator ca = Calculator.createCalculator(); Map map = new HashMap(); map.put("p1", 2); ParameterMapNameSpace space = ParameterMapNameSpace.create(map); ca.pushNameSpace(space); System.out.println(ca.eval(new Formula("$p1 + 3")));
    
    指定者:
    
    pushNameSpace 在接口中 CalculatorProvider
    
    参数:
    ns - 名字空间
  - removeNameSpace
```
public boolean removeNameSpace(NameSpace ns)
```
    从全局名字空间链上移除一个指定的名字空间
    
    指定者:
    
    removeNameSpace 在接口中 CalculatorProvider
    
    参数:
    ns - 要移除的名字空间
    
    返回:
    名字空间移除成功则返回true，否则返回false
  - resolveVariable
```
public java.lang.Object resolveVariable(java.lang.Object var)
```
    将给定的表达式计算出结果
    
    指定者:
    
    resolveVariable 在接口中 CalculatorProvider
    
    参数:
    var - 要计算的表达式
    
    返回:
    计算结果
  - resolveVariableInCE
```
public java.lang.Object resolveVariableInCE(java.lang.Object var)
```
    在单元格范畴内计算表达式的值
    
    指定者:
    
    resolveVariableInCE 在接口中 CalculatorProvider
    
    参数:
    var - 表达式
    
    返回:
    计算结果
  - resolveMethod
```
public Function resolveMethod(java.lang.Object var)
```
    将表达式转化为一个函数并返回
    
    指定者:
    
    resolveMethod 在接口中 CalculatorProvider
    
    参数:
    var - 表达式
    
    返回:
    函数
  - setCurrentFromColumnRow
```
@Deprecated
public void setCurrentFromColumnRow(ColumnRow cr)
```
    已过时。
    
    从接口复制的说明: CalculatorProvider
    
    替换之前的setAttr(ColumnRow.class)
    
    指定者:
    
    setCurrentFromColumnRow 在接口中 CalculatorProvider
  - getCurrentFromColumnRow
```
@Deprecated
public ColumnRow getCurrentFromColumnRow()
```
    已过时。
    
    指定者:
    
    getCurrentFromColumnRow 在接口中 CalculatorProvider
  - resolveRelateCellElements
```
public java.lang.Object resolveRelateCellElements(ColumnRow cr)
```
    获取指定单元格的关联格子
    
    指定者:
    
    resolveRelateCellElements 在接口中 CalculatorProvider
    
    参数:
    cr - 表示单元格的行列对象
    
    返回:
    和给定格子相关联的格子
  - parse
```
public Expression parse(java.lang.Object o)
                 throws com.fr.third.antlr.ANTLRException
```
    将一个对象解析成函数表达式
    
    指定者:
    
    parse 在接口中 CalculatorProvider
    
    参数:
    o - 一般对象
    
    返回:
    函数表达式
    
    抛出:
    
    com.fr.third.antlr.ANTLRException - 如果给定的对象无法正确的解析成函数表达式则抛出此异常
  - parse
```
public Expression parse(java.lang.String statement)
                 throws com.fr.third.antlr.ANTLRException
```
    将字符串解析成函数表达式
    
    指定者:
    
    parse 在接口中 CalculatorProvider
    
    参数:
    statement - 待解析的字符串
    
    返回:
    函数表达式
    
    抛出:
    
    com.fr.third.antlr.ANTLRException - 如果给定的字符串无法正确的解析成函数表达式则抛出此异常
  - evalValue
```
public java.lang.Object evalValue(java.lang.String obj)
                           throws UtilEvalError
```
    计算给定表达式的结果并使用转换器转换结算结果
    
    指定者:
    
    evalValue 在接口中 CalculatorProvider
    
    参数:
    obj - 表达式
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError - 如果表达式无法解析则抛出此异常
  - evalValue
```
public java.lang.Object evalValue(FormulaProvider obj)
                           throws UtilEvalError
```
    计算给定公式的结果并使用转换器转换结算结果
    
    指定者:
    
    evalValue 在接口中 CalculatorProvider
    
    参数:
    obj - 公式
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError - 如果公式无法正确解析则抛出此异常
  - evalValue
```
public java.lang.Object evalValue(Node obj)
                           throws UtilEvalError
```
    计算给定的函数节点并使用转换器转换结算结果
    
    指定者:
    
    evalValue 在接口中 CalculatorProvider
    
    参数:
    obj - 函数节点
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError - 如果无法正确解析该函数节点则抛出此异常
  - eval
```
public java.lang.Object eval(java.lang.String obj)
                      throws UtilEvalError
```
    根据obj的类型判断计算方式如果是单元格，默认计算出来就是单元格，不会取值
    
    指定者:
    
    eval 在接口中 CalculatorProvider
    
    参数:
    obj - 待计算的字符串
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError
  - evalAuth
```
public java.lang.Object evalAuth()
```
  - eval
```
public java.lang.Object eval(FormulaProvider obj)
                      throws UtilEvalError
```
    计算给定的公式的值
    计算一个公式得到结果：
    Calculator ca = Calculator.createCalculator(); System.out.println(ca.eval(new Formula("1 + 2 * 3")));
    
    指定者:
    
    eval 在接口中 CalculatorProvider
    
    参数:
    obj - 公式
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError
  - eval
```
public java.lang.Object eval(Node obj)
                      throws UtilEvalError
```
    计算给定的函数节点的值
    
    指定者:
    
    eval 在接口中 CalculatorProvider
    
    参数:
    obj - 函数节点
    
    返回:
    计算结果
    
    抛出:
    
    UtilEvalError
  - relatedColumnRowRangeArray
```
public static ColumnRowRange[] relatedColumnRowRangeArray(java.lang.String statement)
                                                   throws com.fr.third.antlr.ANTLRException
```
    解析表达式中相关的扩展格子
    下面的返回结果是A1行列和C1行列：
    Calculator.createCalculator().relatedColumnRowRangeArray("left(A1,2) + 'B1' + C1");
    
    参数:
    statement - 给定的表达式
    
    返回:
    相关的扩展格子组成的数组
    
    抛出:
    
    com.fr.third.antlr.ANTLRException
  - relatedParameters
```
public static java.lang.String[] relatedParameters(java.lang.String statement)
                                            throws com.fr.third.antlr.ANTLRException
```
    解析给定的表达式中相关的参数
    下面的返回结果是"$C1"这个参数名：
    Calculator.createCalculator().relatedParameters("left(A1,2) + 'B1' + $C1");
    
    参数:
    statement - 需要解析的表达式
    
    返回:
    相关参数组成的数组
    
    抛出:
    
    com.fr.third.antlr.ANTLRException
  - putConnection
```
public void putConnection(java.lang.String name,
                 java.sql.Connection conn)
```
    添加连接
    
    参数:
    name - 连接名称
    conn - 连接
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String name)
```
  - removeConnection
```
public void removeConnection(java.lang.String name)
```
    移除连接
    
    参数:
    name - 连接名
  - exStatement
```
public java.lang.String exStatement(ColumnRow currentColumnRow,
                           java.lang.String statement)
```
    解析表达式
    
    指定者:
    
    exStatement 在接口中 CalculatorProvider
    
    参数:
    currentColumnRow - 当前行列
    statement - 要执行的语句
    
    返回:
    解析结果
  - getLocator
```
public CalculateLocator getLocator()
```
    从接口复制的说明: CalculatorProvider
    
    获取计算坐标系
    
    指定者:
    
    getLocator 在接口中 CalculatorProvider
  - getCurrentColumnRow
```
public ColumnRow getCurrentColumnRow()
```
    从接口复制的说明: CalculatorProvider
    
    获取在计算中正在使用的格子
    
    指定者:
    
    getCurrentColumnRow 在接口中 CalculatorProvider
    
    返回:
    正在参数计算的格子
  - setCurrentColumnRow
```
@Deprecated
public void setCurrentColumnRow(ColumnRow columnRow)
```
    已过时。
    
    指定者:
    
    setCurrentColumnRow 在接口中 CalculatorProvider
  - onAddDeleteColumnOrRow
```
public java.lang.String onAddDeleteColumnOrRow(java.lang.String statement,
                                      int rowIndex,
                                      int rowChanged,
                                      int columnIndex,
                                      int colChanged)
```
    alex: 当行列添加时
    
    参数:
    statement - 表达式
    rowIndex - 行序号
    rowChanged - 行改变
    columnIndex - 列序号
    colChanged - 列改变
    
    返回:
    结果表达式
  - getNameSpaceList
```
public java.util.LinkedList getNameSpaceList()
```

类 Calculator

嵌套类概要

字段概要

从接口继承的字段 com.fr.stable.script.CalculatorProvider

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SHEET_NUMBER_KEY

方法详细资料

createCalculator

putThreadSavedNameSpace

setThreadSavedParameter

clearThreadSavedParameter

getSavedVariables

getSavedSessionNameSpace

processParameters

setAttribute

setAttribute

getAttribute

getAttribute

removeAttribute

set

remove

pushNameSpace

removeNameSpace

resolveVariable

resolveVariableInCE

resolveMethod

setCurrentFromColumnRow

getCurrentFromColumnRow

resolveRelateCellElements

parse

parse

evalValue

evalValue

evalValue

eval

evalAuth

eval

eval

relatedColumnRowRangeArray

relatedParameters

putConnection

getConnection

removeConnection

exStatement

getLocator

getCurrentColumnRow

setCurrentColumnRow

onAddDeleteColumnOrRow

getNameSpaceList