How salesforce/formula-engine works
formula-engine is a reusable, Salesforce-syntax formula library with Java evaluation and JavaScript/SQL generation. The principal workflow is to configure hooks, types and a data context; compile a formula through the factory; then evaluate the compiled formula with a runtime context. Compiled formula information can be reused with different runtime contexts. The README also documents template support and client/offline JavaScript use. Relationships below follow README statements; unsampled implementation details are not inferred.
Main entry points: FormulaImpl.java Compiled formula · FormulaFactoryImpl.java Formula factory · FormulaContext.java Data context · FormulaSQLProvider.java SQL generation API
Components 15
Application integration
- Engine hooks
api/src/main/java/com/force/formula/FormulaEngineHooks.java - Formula type config
api/src/main/java/com/force/formula/FormulaTypeSpec.java - Data types
api/src/main/java/com/force/formula/FormulaDataType.java
Formula compilation
- Formula factory
impl/src/main/java/com/force/formula/impl/FormulaFactoryImpl.java - Formula parser
impl/src/main/java/com/force/formula/impl/FormulaParserImpl.java - Formula commands
impl/src/main/java/com/force/formula/commands - Compiled formula
impl/src/main/java/com/force/formula/impl/FormulaImpl.java - Template functions
impl/src/main/java/com/force/formula/template/commands
Evaluation and contexts
- Data context
api/src/main/java/com/force/formula/FormulaContext.java - Runtime context
api/src/main/java/com/force/formula/FormulaRuntimeContext.java - Schema metadata
api/src/main/java/com/force/formula/FormulaSchema.java
Output generation
- SQL generation API
api/src/main/java/com/force/formula/sql/FormulaSQLProvider.java - SQL dialect hooks
impl/src/main/java/com/force/formula/impl/sql - JavaScript runtime
impl/src/main/resources/com/force/formula/formulaEngine.js
Other components
- Application
Connections 13
- Application → Engine hooks: configures
README.md - Application → Formula type config: implements
README.md - Application → Data types: implements
README.md - Application → Data context: provides
README.md - Application → Formula factory: customizes
README.md - Formula factory → Formula parser: compiles
- Application → Compiled formula: creates
README.md - Compiled formula → Runtime context: evaluates with
README.md - Data context → Schema metadata: exposes
api/src/main/java/com/force/formula/FormulaContext.java - Compiled formula → SQL generation API: generates SQL
README.md - SQL generation API → SQL dialect hooks: uses dialects
- Compiled formula → JavaScript runtime: generates JavaScript
README.md - Application → Template functions: extends with