Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #34

Merged
merged 1 commit into from
Nov 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ For an equivalent of a (ANTLR) grammar definition look at `ExpressionGrammar`.
The public API of the library is encapsulated by `Expression` which refers to types
in the `org.hisp.dhis.lib.expression.spi` package.

For JavaScript the main entry point to the API is called `ExpressionJs`.

### Modes
DHIS2 has several expression language, each supporting a different set of functions.
To select which expression is used the `Expression` is parameterized with a `Mode`.
Expand All @@ -43,4 +45,4 @@ To select which expression is used the `Expression` is parameterized with a `Mod
* `INDICATOR_EXPRESSION`: Computes a number for an indicator expression (ad-hoc aggregate data computation)
* `PROGRAM_INDICATOR_EXPRESSION`: Computes a number for a program indicator expression (persisted aggregate data computation)
* `RULE_ENGINE_CONDITION`: Computes a boolean to check if a rule applies
* `RULE_ENGINE_ACTION`: Computes a boolean, string, number or date from a rule
* `RULE_ENGINE_ACTION`: Computes a boolean, string, number or date from a rule