API - openVALIDATION

openVALIDATION is mainly used as CLI in the console. However, it is possible to directly access the API of openVALIDATION for better integration in Java projects. For this purpose openVALIDATION provides a Maven package called openvalidation-core:
1
<dependency>
2
    <groupId>org.bag.openvalidation</groupId>
3
    <artifactId>openvalidation-core</artifactId>
4
    <version>1.0-SNAPSHOT</version>
5
    <scope>compile</scope>
6
</dependency>
Copied!
First you need an instance of the class org.bag.opernvalidation.core.OpenValidation. This is instantiated as follows:
1
OpenValidation ov = OpenValidation.createDefault();
Copied!
Parameters can now be initialized:
1
ov.setLanguage(Language.Node)
2
ov.setLocale("en");
3
ov.setSchema("{age:0}");
4
ov.setRule("the age of the applicant MUST be AT LEAST 18");
Copied!
Now the code can be generated:
1
OpenValidationResult result = ov.generateCode();
Copied!
The object result of the type org.bag.openvalidation.common.model.OpenValidationResultcontains all information and results of the generation process. Among other things, the information whether errors occurred.
1
if ( ov.hasErrors() ) {
2
    Sytem.out.print(ov.toErrorString(true)) //verbose: true
3
}
Copied!
If there were no errors, then you can access the code results with the following calls:
1
//get implemented rules
2
List<CodeGenerationResult> implResults = ov.getImplementationResults(); 
3
​
4
//get framework part
5
CodeGenerationResult framework = ov.getFrameworkResult()
Copied!
The generated code always consists of two components. From the implemented rules and your own framework. The framework ensures that the generated code has no external dependencies.
This is how the code is accessed:
1
String rulesCode = implResults.get(0).getCode();
2
String frameworkCode = framework.getCode();
Copied!
This is how the generated rules look like in Node.js or JavaScript:
1
var huml = require('./HUMLFramework');
2
​
3
var HUMLValidator = function() {
4
​
5
    huml.appendRule("",
6
           ["age"],
7
           "the age of the applicant MUST be AT LEAST 18",
8
           function(model) { return  huml.LESS_THAN(model.age, 18.0);},
9
           false
10
    );
11
​
12
    this.validate = function(model){
13
        return huml.validate(model);
14
    }
15
}
Copied!

Command Line Interface

Best practice

Last modified 2yr ago

Copy link