com.aspc.Util.Formula

Class Formula

java.lang.Object

com.aspc.Util.Formula.Formula

All Implemented Interfaces:

Calculatable

Direct Known Subclasses:

DBFormula, DummyFormula, SimpleFormula

public abstract class Formula
extends java.lang.Object
implements Calculatable

Formula A formula is made up of operators, functions, numerical values and user defined data items. Operators are ()-+/*,"'
THREAD MODE: MULTI-THREADED formula is shared

Since:

29 September 2006

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected int	callCount
protected boolean	compiledFlag
protected java.lang.String	compiledSummary
protected java.lang.String	definition
protected static java.util.concurrent.ConcurrentHashMap<java.lang.Class,java.util.HashMap>	FUNCTION_TABLE
protected java.util.HashMap<java.lang.String,Function>	functions
protected java.lang.Object[]	list
protected java.lang.String	name
protected static java.lang.String	OPERATORS
protected java.lang.String	originalDefinition
protected java.lang.Object	specialHolder
protected java.lang.String	summary
static Version	VERSION

Constructor Summary

Constructors

Constructor and Description
Formula(java.lang.String desc) Create a new formula
Formula(java.lang.String desc, java.lang.String name) Create a new formula
Formula(java.lang.String desc, java.lang.String name, boolean autoCompile) Create a new formula
Formula(java.lang.String desc, java.lang.String name, boolean autoCompile, java.lang.Object specialHolder) Creates a formula.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addDependentItem(java.lang.Object obj, java.util.HashMap dependents) add the dependent items
protected void	appendNumber(java.lang.Appendable info, double d) For informational purposes add a number and make it look nice.
double	calculate(Query query)
double	calculate(Query query, java.lang.Appendable info, CalculationPathNode parentCalcNode)
protected double	calculate(Query query, int[] pos, java.lang.Appendable info, CalculationPathNode parentCalcNode) Walk through all elements in the formula and return the result.
double	calculateV1(Query query)
double	calculateV2(Query query)
protected boolean	checkAndMove(int[] pos, java.lang.Object match)
void	compile()
java.lang.Object	compute(Query query)
java.lang.Object	compute(Query query, java.lang.Appendable info, CalculationPathNode parentCalcNode)
java.lang.Object	computeV1(Query query)
java.lang.Object	computeV2(Query query)
java.lang.String	convertToJavaScript()
protected java.lang.String	convertToJavaScript(java.util.HashMap<java.lang.String,java.lang.String> functionMap)
java.util.HashMap	findDependents()
java.util.HashMap	findDependents(java.util.HashMap dependents)
protected java.lang.Object	getDefinedItem(java.lang.String n)
java.lang.String	getDefinition()
java.lang.String	getDetails(Query query)
java.lang.String	getHelp()
Formula	getInternalSection(int section)
int	getInternalSectionCount()
protected double	getItem(Query query, java.lang.Object o, java.lang.Appendable info, CalculationPathNode parentCalcNode) Extend this method to add your own variables
java.lang.Object[]	getItems()
java.lang.String	getName() Returns the name of this formula.
java.lang.String	getSummary(int indent, boolean shouldIndent, int[] pos, boolean short_fg, boolean formatHTML)
protected double	handleOp(double amount, double d, java.lang.String op)
boolean	isCompiled()
boolean	isTextItemAllowed()
static java.lang.Object	legacy(java.lang.String functionCode, java.lang.Object[] arguments) calls legacy functions
protected abstract Formula	makeFormula(java.lang.String formula) This method is used to create internal formulas.
protected java.lang.Object	next(int[] pos)
protected void	parseFormula(java.util.StringTokenizer st, java.util.ArrayList items)
protected void	registerFunctions(java.util.HashMap table)
void	setAllowTextItem(boolean isAllow)
java.lang.String	showCompiledVersion()
java.lang.String	showCompiledVersionHTML()
java.lang.String	showLongVersion()
protected boolean	splitUp(java.lang.String text, java.util.ArrayList items)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final Version VERSION

OPERATORS

protected static final java.lang.String OPERATORS

See Also:

Constant Field Values

FUNCTION_TABLE

protected static final java.util.concurrent.ConcurrentHashMap<java.lang.Class,java.util.HashMap> FUNCTION_TABLE

compiledFlag

protected boolean compiledFlag

list

protected java.lang.Object[] list

callCount

protected int callCount

functions

protected java.util.HashMap<java.lang.String,Function> functions

originalDefinition

protected java.lang.String originalDefinition

definition

protected java.lang.String definition

name

protected java.lang.String name

summary

protected java.lang.String summary

compiledSummary

protected java.lang.String compiledSummary

specialHolder

protected java.lang.Object specialHolder

Constructor Detail

Formula

public Formula(java.lang.String desc)
        throws java.lang.Exception

Create a new formula

Parameters:

desc -

Throws:

java.lang.Exception - a serious problem

Formula

public Formula(java.lang.String desc,
               java.lang.String name)
        throws java.lang.Exception

Create a new formula

Parameters:

desc -

name -

Throws:

java.lang.Exception - a serious problem

Formula

public Formula(java.lang.String desc,
               java.lang.String name,
               boolean autoCompile)
        throws java.lang.Exception

Create a new formula

Parameters:

desc -

name -

autoCompile -

Throws:

java.lang.Exception - a serious problem

Formula

public Formula(java.lang.String desc,
               java.lang.String name,
               boolean autoCompile,
               java.lang.Object specialHolder)
        throws java.lang.Exception

Creates a formula.

Parameters:

desc -

name -

autoCompile -

specialHolder -

Throws:

java.lang.Exception - a serious problem

Method Detail

legacy

@CheckReturnValue
public static java.lang.Object legacy(java.lang.String functionCode,
                                                        java.lang.Object[] arguments)

calls legacy functions

Parameters:

functionCode - the function code.

arguments - the arguments

Returns:

the value

convertToJavaScript

@CheckReturnValue
public java.lang.String convertToJavaScript()
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

convertToJavaScript

protected java.lang.String convertToJavaScript(java.util.HashMap<java.lang.String,java.lang.String> functionMap)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

compute

@CheckReturnValue
public java.lang.Object compute(@Nonnull
                                                  Query query,
                                                  java.lang.Appendable info,
                                                  CalculationPathNode parentCalcNode)
                                           throws java.lang.Exception

Specified by:

compute in interface Calculatable

Returns:

the value

Throws:

java.lang.Exception - * @a serious problem.

compute

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

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

computeV2

@CheckReturnValue
public java.lang.Object computeV2(@Nonnull
                                                    Query query)
                                             throws java.lang.Exception

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

computeV1

@CheckReturnValue
public java.lang.Object computeV1(@Nonnull
                                                    Query query)
                                             throws java.lang.Exception

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calculate

@CheckReturnValue
public double calculate(@Nonnull
                                          Query query)
                                   throws java.lang.Exception

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calculateV1

@CheckReturnValue
public double calculateV1(@Nonnull
                                            Query query)
                                     throws java.lang.Exception

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calculateV2

@CheckReturnValue
public double calculateV2(@Nonnull
                                            Query query)
                                     throws java.lang.Exception

Parameters:

query -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calculate

@CheckReturnValue
public double calculate(Query query,
                                          java.lang.Appendable info,
                                          CalculationPathNode parentCalcNode)
                                   throws java.lang.Exception

Specified by:

calculate in interface Calculatable

Parameters:

query -

info -

parentCalcNode - parent calculation mode.

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getItems

@CheckReturnValue
public java.lang.Object[] getItems()

Returns:

the value

isCompiled

@CheckReturnValue
public boolean isCompiled()

Returns:

the value

getName

@CheckReturnValue
public java.lang.String getName()

Returns the name of this formula.

Returns:

the name

getInternalSection

@CheckReturnValue
public Formula getInternalSection(int section)

Parameters:

section -

Returns:

the value

getInternalSectionCount

@CheckReturnValue
public int getInternalSectionCount()

Returns:

the value

compile

public void compile()
             throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

splitUp

protected boolean splitUp(java.lang.String text,
                          java.util.ArrayList items)
                   throws java.lang.Exception

Parameters:

text -

items -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

parseFormula

protected void parseFormula(java.util.StringTokenizer st,
                            java.util.ArrayList items)
                     throws java.lang.Exception

Parameters:

st -

items -

Throws:

java.lang.Exception - a serious problem

getDefinedItem

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

Parameters:

n -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

registerFunctions

protected void registerFunctions(java.util.HashMap table)

Parameters:

table -

getHelp

@CheckReturnValue
public java.lang.String getHelp()

Returns:

the value

getDetails

@CheckReturnValue
public java.lang.String getDetails(Query query)

Parameters:

query -

Returns:

the value

toString

@Nonnull
 @CheckReturnValue
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the value

showCompiledVersion

@CheckReturnValue
public java.lang.String showCompiledVersion()

Returns:

the value

showCompiledVersionHTML

@CheckReturnValue
public java.lang.String showCompiledVersionHTML()

Returns:

the value

showLongVersion

@CheckReturnValue
public java.lang.String showLongVersion()

Returns:

the value

getSummary

@CheckReturnValue
public java.lang.String getSummary(int indent,
                                                     boolean shouldIndent,
                                                     int[] pos,
                                                     boolean short_fg,
                                                     boolean formatHTML)

Parameters:

pos -

indent -

shouldIndent -

short_fg -

formatHTML -

Returns:

the value

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

Parameters:

parentCalcNode - The parent node

query - the user query

o - the section object

info - the info buffer MAYBE NULL

Returns:

the item

Throws:

java.lang.Exception - a serious problem

handleOp

protected double handleOp(double amount,
                          double d,
                          java.lang.String op)

Parameters:

amount -

d -

op -

Returns:

the value

appendNumber

protected void appendNumber(java.lang.Appendable info,
                            double d)

For informational purposes add a number and make it look nice.

Parameters:

info - The buffer to be appended to

d - The actual number to append

makeFormula

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

This method is used to create internal formulas. You must overload this method to produce a formula of your type.

Parameters:

formula -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

calculate

protected double calculate(@Nonnull
                           Query query,
                           int[] pos,
                           java.lang.Appendable info,
                           CalculationPathNode parentCalcNode)
                    throws NullValueException,
                           java.lang.Exception

Walk through all elements in the formula and return the result.

Parameters:

pos - the position

query - The parameters for this calculation

info - if not null return the calculation info.

parentCalcNode - parent calculation mode.

Returns:

the result.

Throws:

java.lang.Exception - a serious problem

NullValueException - thrown if the result is null.

checkAndMove

protected boolean checkAndMove(int[] pos,
                               java.lang.Object match)

Parameters:

pos -

match -

Returns:

the value

next

protected java.lang.Object next(int[] pos)

Parameters:

pos -

Returns:

the value

setAllowTextItem

public void setAllowTextItem(boolean isAllow)

Parameters:

isAllow -

isTextItemAllowed

public boolean isTextItemAllowed()

Returns:

the value

getDefinition

public java.lang.String getDefinition()

Specified by:

getDefinition in interface Calculatable

Returns:

the value

findDependents

public java.util.HashMap findDependents()
                                 throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

findDependents

public java.util.HashMap findDependents(java.util.HashMap dependents)
                                 throws java.lang.Exception

Parameters:

dependents -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

addDependentItem

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

add the dependent items

Parameters:

dependents - the items.

obj - Object to be added to the dependent list

Throws:

java.lang.Exception - Serious Problem