com.aspc.DBObj.Formula

Class DBFormula

java.lang.Object

com.aspc.Util.Formula.Formula

com.aspc.DBObj.Formula.DBFormula

All Implemented Interfaces:

Calculatable

public class DBFormula
extends Formula

DBFormula is a formula processor formula engine for DBObjects. THREAD MODE: MULTI-THREADED shared

Since:

January 18, 2001, 6:49 PM

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.Util.Formula.Formula

callCount, compiledFlag, compiledSummary, definition, FUNCTION_TABLE, functions, list, name, OPERATORS, originalDefinition, specialHolder, summary, VERSION

Constructor Summary

Constructors

Constructor and Description
DBFormula(java.lang.String formula) a database formula

Method Summary

Modifier and Type	Method and Description
protected void	addDependentItem(java.lang.Object obj, java.util.HashMap dependents) add the dependent items
java.lang.Object	compute(Query query) compute the formula
protected java.lang.Object	getDefinedItem(java.lang.String name) get the defined value
protected double	getItem(Query query, java.lang.Object o, java.lang.Appendable info, CalculationPathNode parentCalcNode) Extend this method to add your own variables
protected Formula	makeFormula(java.lang.String formula) make a sub formula

Methods inherited from class com.aspc.Util.Formula.Formula

appendNumber, calculate, calculate, calculate, calculateV1, calculateV2, checkAndMove, compile, compute, computeV1, computeV2, convertToJavaScript, convertToJavaScript, findDependents, findDependents, getDefinition, getDetails, getHelp, getInternalSection, getInternalSectionCount, getItems, getName, getSummary, handleOp, isCompiled, isTextItemAllowed, legacy, next, parseFormula, registerFunctions, setAllowTextItem, showCompiledVersion, showCompiledVersionHTML, showLongVersion, splitUp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DBFormula

public DBFormula(java.lang.String formula)
          throws java.lang.Exception

a database formula

Parameters:

formula - the text version of the formula

Throws:

java.lang.Exception - a serious problem

Method Detail

compute

public java.lang.Object compute(Query query)
                         throws java.lang.Exception

compute the formula

Overrides:

compute in class Formula

Parameters:

query - the user query

Returns:

the computed value

Throws:

java.lang.Exception - a serious problem

getDefinedItem

protected java.lang.Object getDefinedItem(java.lang.String name)
                                   throws java.lang.Exception

get the defined value

Overrides:

getDefinedItem in class Formula

Parameters:

name - the name of the value

Returns:

the value

Throws:

java.lang.Exception - a serious problem

makeFormula

protected Formula makeFormula(java.lang.String formula)
                       throws java.lang.Exception

make a sub formula

Specified by:

makeFormula in class Formula

Parameters:

formula - the text of the sub formula.

Returns:

the sub formula

Throws:

java.lang.Exception - a serious problem

getItem

protected double getItem(Query query,
                         java.lang.Object o,
                         java.lang.Appendable info,
                         CalculationPathNode parentCalcNode)
                  throws java.lang.Exception

Extend this method to add your own variables

Overrides:

getItem in class Formula

Parameters:

query - the user query

o - the section object

info - the info buffer MAYBE NULL

parentCalcNode - The parent node

Returns:

the item

Throws:

java.lang.Exception - a serious problem

addDependentItem

protected void addDependentItem(java.lang.Object obj,
                                java.util.HashMap dependents)
                         throws java.lang.Exception

add the dependent items

Specified by:

addDependentItem in class Formula

Parameters:

dependents - the items.

obj - Object to be added to the dependent list

Throws:

java.lang.Exception - Serious Problem