com.aspc.Util.Formula

Class Function

java.lang.Object

com.aspc.Util.Formula.Function

Direct Known Subclasses:

AndFunction, EqFunction, EqIgnoreCaseFunction, IfnullFunction, MaxFunction, MinFunction, OldFunction, OrFunction, StackFunction

public abstract class Function
extends java.lang.Object

Function
THREAD MODE: MULTI-THREADED function

Since:

July 4, 2003, 2:42 PM

Author:

Nigel Leck

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Function(java.lang.String syntax)
protected	Function(java.lang.String code, java.lang.String signature, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
abstract double	calculate(Query query, Formula formula, java.lang.Appendable orgInfo, CalculationPathNode parentCalcNode)
void	checkSignature(java.lang.Object internalFormula)
void	compile()
java.lang.Object	compute(Query query, Formula formula, java.lang.Appendable orgInfo, CalculationPathNode parentCalcNode)
java.lang.String	getCode()
java.lang.String	getDescription()
java.lang.String	getInfo()
java.lang.String	getJavaScript()
java.lang.String	getSignature()
protected void	iSetCode(java.lang.String code)
protected void	iSetDescription(java.lang.String description)
protected void	iSetSignature(java.lang.String signature)
java.lang.String	parseStringParameter(Query query, Formula formula, int position) Returns the String parameter at position If the parameter is not a StringItem, null is returned
void	register(java.util.HashMap table) register this function.

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

protected Function(java.lang.String syntax)

Parameters:

syntax -

Function

protected Function(java.lang.String code,
                   java.lang.String signature,
                   java.lang.String description)

Parameters:

code -

signature -

description -

Method Detail

register

public void register(java.util.HashMap table)
              throws CompileException

register this function.

Parameters:

table -

Throws:

CompileException

checkSignature

public void checkSignature(java.lang.Object internalFormula)
                    throws CompileException

Parameters:

internalFormula -

Throws:

CompileException

compile

public void compile()
             throws CompileException

Throws:

CompileException

calculate

public abstract double calculate(Query query,
                                 Formula formula,
                                 java.lang.Appendable orgInfo,
                                 CalculationPathNode parentCalcNode)
                          throws NullValueException,
                                 java.lang.Exception

Parameters:

query -

formula -

orgInfo -

parentCalcNode -

Returns:

the value

Throws:

NullValueException

java.lang.Exception - a serious problem

compute

public java.lang.Object compute(Query query,
                                Formula formula,
                                java.lang.Appendable orgInfo,
                                CalculationPathNode parentCalcNode)
                         throws NullValueException,
                                java.lang.Exception

Parameters:

query -

formula -

orgInfo -

parentCalcNode -

Returns:

the value

Throws:

NullValueException

java.lang.Exception - a serious problem

iSetCode

protected final void iSetCode(java.lang.String code)

Parameters:

code -

getCode

public final java.lang.String getCode()

Returns:

the value

getJavaScript

public java.lang.String getJavaScript()
                               throws java.lang.Exception

Throws:

java.lang.Exception

iSetSignature

protected final void iSetSignature(java.lang.String signature)

Parameters:

signature -

getSignature

public java.lang.String getSignature()

Returns:

the value

iSetDescription

protected final void iSetDescription(java.lang.String description)

Parameters:

description -

getDescription

public java.lang.String getDescription()

Returns:

the value

getInfo

public final java.lang.String getInfo()

Returns:

the value

parseStringParameter

public java.lang.String parseStringParameter(Query query,
                                             Formula formula,
                                             int position)
                                      throws java.lang.Exception

Returns the String parameter at position If the parameter is not a StringItem, null is returned

Parameters:

query -

formula -

position -

Returns:

the value

Throws:

java.lang.Exception - a serious problem