Classes and Interfaces
DecimalFormulaResult	Decimal formula result.
FloatFormulaResult	Floating point formula result.
IFormula	Defines a formula, expressed as a variant of the Spring Expression Language (SpEL), that combines MJ variables, functions and literals with standard operators like + (addition) and * (multiplication).
IntegerFormulaResult	Integer formula result.
MJFormulaContext	Abstract base class for formula contexts, provides MJ variables and other evaluation context to a formula.
MJFormulaFactory	Abstract base class for creating formulas, all formula factory classes that create concrete formula implementations derive from this class.
MJFormulaResult	Abstract base formula result class.

Class: DecimalFormulaResult   next package

Decimal formula result.

Constructors

Public ctor for initializing an instance of this class. Parameters: aResultVar - decimal that is the result of a formula evaluation. public DecimalFormulaResult(java.math.BigDecimal aResultVar)

Methods

public java.math.BigDecimal result()

Class: FloatFormulaResult   previous next package

Floating point formula result.

Constructors

Public ctor for initializing an instance of this class. Parameters: aResultVar - floating point number that is the result of a formula evaluation. public FloatFormulaResult(java.lang.Double aResultVar)

Methods

public java.lang.Double result()

Interface: IFormula   previous next package

Defines a formula, expressed as a variant of the Spring Expression Language (SpEL), that combines MJ variables, functions and literals with standard operators like + (addition) and * (multiplication).

Assuming tax and amt are MJ variables, the formula below evaluates to the 10% discount on an taxed purchase.

(amt + tax)* 0.10

Parameters:

<T> - the expected return type of the formula upon evaluation (e.g., BigDecimal, Integer, Calendar).
<C> - type of formula context expected by formula.

Methods

Parse and evaluate a formula. Options specified during formula creation (see MJFormulaFactory) are in effect. Parameters: aFormula - formula expression. aContext - provides MJ variables and other evaluation context. Throws: MJExecuteException - if an error occurs during formula evaluation. Returns: result of formula, coerced to type T. public com.arsi.mj.fml.MJFormulaResult evaluate(java.lang.String aFormula, com.arsi.mj.fml.MJFormulaContext aContext)     throws com.arsi.mj.MJExecuteException

Class: IntegerFormulaResult   previous next package

Integer formula result.

Constructors

Public ctor for initializing an instance of this class. Parameters: aResultVar - integer that is the result of a formula evaluation. public IntegerFormulaResult(java.lang.Long aResultVar)

Methods

public java.lang.Long result()

Class: MJFormulaContext   previous next package

Abstract base class for formula contexts, provides MJ variables and other evaluation context to a formula.

Treat this class as "thread-hostile"; instances should be created, used and discarded by a single thread at a time.

Fields

Environmental variable namespace. public final com.arsi.mj.variable.MJVariableNamespace envNamespace

Global variable namespace. public final com.arsi.mj.variable.MJVariableNamespace globalNamespace

Local variable namespace. public final com.arsi.mj.variable.MJVariableNamespace localNamespace

TEMP variable namespace (temporary variables created during evaluation of multiple formulae). public final com.arsi.mj.variable.MJVariableNamespace tempNamespace

Initialized variable transformer. public final com.arsi.mj.maprpt.vidxform.MJVariableIdentifierTransformer variableIdTransformer

Constructors

Restricted ctor for initializing an instance of this class. Parameters: aGlobalNS - global variable namespace aEnvNS - environmental variable namespace aLocalNS - local variable namespace aTempNS - temporary variable namespace aTransformer - variable transformation utility protected MJFormulaContext(com.arsi.mj.variable.MJVariableNamespace aGlobalNS, com.arsi.mj.variable.MJVariableNamespace aEnvNS, com.arsi.mj.variable.MJVariableNamespace aLocalNS, com.arsi.mj.variable.MJVariableNamespace aTempNS, com.arsi.mj.maprpt.vidxform.MJVariableIdentifierTransformer aTransformer)

Methods

Retrieves an array variable by name, using the provided variable as the source of the name. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the name source to dereference anIndex - the index of the array element Returns: the obtained variable, or null if none is found public java.lang.Object elemByName(com.arsi.mj.variable.MJVariable aVariable, int anIndex)

Retrieves an array variable by name, using the provided variable as the source of the name. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the name source to dereference anIndexVariable - the index source to dereference Returns: the obtained variable, or null if none is found public java.lang.Object elemByName(com.arsi.mj.variable.MJVariable aVariable, com.arsi.mj.variable.MJVariable anIndexVariable)

Retrieves an array variable by number, using the provided variable as the source of the number. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the name source to dereference anIndex - the index of the array element Returns: the obtained variable, or null if none is found public java.lang.Object elemByNum(com.arsi.mj.variable.MJVariable aVariable, int anIndex)

Retrieves an array variable by number, using the provided variable as the source of the number. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the name source to dereference anIndexVariable - the index source to dereference Returns: the obtained variable, or null if none is found public java.lang.Object elemByNum(com.arsi.mj.variable.MJVariable aVariable, com.arsi.mj.variable.MJVariable anIndexVariable)

Determines the namespace corresponding to the provided scope. Parameters: aScope - the scope for which the namespace will be retrieved Returns: the matching namespace public com.arsi.mj.variable.MJVariableNamespace getNamespace(com.arsi.mj.VariableScope aScope)

Retrieves a variable by name, using the provided variable as the source of the name. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the name source to dereference Returns: the obtained variable, or null if none is found public java.lang.Object varByName(com.arsi.mj.variable.MJVariable aVariable)

Retrieves a variable by number, using the provided variable as the source of the number. The logic for dereferencing takes into account any variable renaming that occurred during the run translation process. Parameters: aVariable - the number source to dereference Returns: the obtained variable, or null if none is found public java.lang.Object varByNum(com.arsi.mj.variable.MJVariable aVariable)

Class: MJFormulaFactory   previous next package

Abstract base class for creating formulas, all formula factory classes that create concrete formula implementations derive from this class.

Concrete formula factory classes may change the default options (EVALUATE_JAVA_TYPE and RETURN_JAVA_TYPE) assumed by the create method, but should document the changed defaults.

Constructors

public MJFormulaFactory()

Methods

Create formula where specified options are in effect during evaluation that returns a decimal. Parameters: someOptions - options that influence formula evaluation. If none specified, defaults to EVALUATE_JAVA_TYPE and RETURN_JAVA_TYPE. Returns: formula that returns an decimal as a result. public abstract com.arsi.mj.fml.IFormula createDecimalFormula(java.util.EnumSet someOptions)

Create formula where specified options are in effect during evaluation that returns a floating point number. Parameters: someOptions - options that influence formula evaluation. If none specified, defaults to EVALUATE_JAVA_TYPE and RETURN_JAVA_TYPE. Returns: formula that returns a floating point number as a result. public abstract com.arsi.mj.fml.IFormula createFloatFormula(java.util.EnumSet someOptions)

Create formula where specified options are in effect during evaluation that returns an opaque object. Parameters: someOptions - options that influence formula evaluation. If none specified, defaults to EVALUATE_JAVA_TYPE and RETURN_JAVA_TYPE. Returns: formula that returns an MJ variable as a result. public abstract com.arsi.mj.fml.IFormula createFormula(java.util.EnumSet someOptions)

Create formula where specified options are in effect during evaluation that returns an integer. Parameters: someOptions - options that influence formula evaluation. If none specified, defaults to EVALUATE_JAVA_TYPE and RETURN_JAVA_TYPE. Returns: formula that returns an integer as a result; if present, the RETURN_EXACT option reports an error if the fractional part of the formula result would be lost when returning an integer. public abstract com.arsi.mj.fml.IFormula createIntegerFormula(java.util.EnumSet someOptions)