From cc0d4107d4c448e910a4363ccebccad6c6d3ec19 Mon Sep 17 00:00:00 2001 From: Jonas Blatt <jonasblatt@uni-koblenz.de> Date: Thu, 10 Oct 2019 20:36:56 +0200 Subject: [PATCH] Add documentation markdown for verifier --- dmnverifierapi/README.md | 3 ++ dmnverifierapi/verifier.md | 72 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 dmnverifierapi/verifier.md diff --git a/dmnverifierapi/README.md b/dmnverifierapi/README.md index 4b9b4621..59c14a8d 100644 --- a/dmnverifierapi/README.md +++ b/dmnverifierapi/README.md @@ -10,3 +10,6 @@ This project contains all source files of the implementation, created for the ma Based on - [Quarkus](https://quarkus.io/) - [Camunda DMN](https://github.com/camunda/camunda-dmn-model/) + +## Verifier +- [Overview verifier](verifier.md) diff --git a/dmnverifierapi/verifier.md b/dmnverifierapi/verifier.md new file mode 100644 index 00000000..a1f52523 --- /dev/null +++ b/dmnverifierapi/verifier.md @@ -0,0 +1,72 @@ +# Verifier +[[_TOC_]] + +## Overview +- [Verification Classification (Group of verifier)](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\classification) +- [Verification Type (identification of verifier + name + description for single verifier)](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\types) +- [Verifier (Concrete implementation)](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\impl) + +## Implementations + +### DRD Modeling Level Verification +- Classification: [DrdModelingLevelVerification](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\classification\DrdModelingLevelVerification.java) + +#### Lonely Data Input Verification +- Type: [LonelyDataInputVerification](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\types\LonelyDataInputVerification.java) +- Verifier: [LonelyDataInputVerifier](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\impl\LonelyDataInputVerifier.java) + +##### Description +Checks for any input data node, if it has **no** connection to at least one decision table. + +##### Algorithm +``` +doVerification (Definition d) { + define rL as ResultList + for each (InputNode i in d.getInputNodes()) { + if (i.hasNoConnectedDecisionNodes()) { + add i to rL + } + } + return rL +} +``` + +### Modeling Level Verification +- Classification: [ModelingLevelVerification](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\classification\ModelingLevelVerification.java) + +#### Predefined Existing Value Verification +- Type: [PredefinedExistingValueVerification](\src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\types\PredefinedExistingValueVerification.java) +- Verifier: [PredefinedExistingValueVerifier](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\impl\PredefinedExistingValueVerifier.java) + +##### Description +TODO + +##### Algorithm +``` +TODO +``` + + +#### Predefined Missing Value Verification +- Type: [PredefinedMissingValueVerification](\src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\types\PredefinedMissingValueVerification.java) +- Verifier: [PredefinedMissingValueVerifier](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\impl\PredefinedMissingValueVerifier.java) + +##### Description +TODO + +##### Algorithm +``` +TODO +``` + + +### Decision Logic Level Verification +- Classification: [DecisionLogicLevelVerification](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\classification\DecisionLogicLevelVerification.java) + +#### TODO... + + +### SyntaxLevelVerification +- Classification: [SyntaxLevelVerification](src\main\java\de\unikoblenz\fgbks\core\dmn\verification\verifier\classification\SyntaxLevelVerification.java) + +#### TODO... -- GitLab