From 6a54b7bd33d2434bb09888c192e3d6b66daa67ae Mon Sep 17 00:00:00 2001 From: Jonas Blatt <jonasblatt@uni-koblenz.de> Date: Fri, 11 Oct 2019 22:04:32 +0200 Subject: [PATCH] Add structure for documentation of verifier --- dmnverifierapi/verifier.md | 119 ++++++++++++++++++++++++++++++++++++- 1 file changed, 116 insertions(+), 3 deletions(-) diff --git a/dmnverifierapi/verifier.md b/dmnverifierapi/verifier.md index a82682b1..021c0e6e 100644 --- a/dmnverifierapi/verifier.md +++ b/dmnverifierapi/verifier.md @@ -56,14 +56,127 @@ TODO TODO ``` +### Empty Output Verification +- Type: [EmptyOutputVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/EmptyOutputVerification.java) +- Verifier: [EmptyOutputVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/EmptyOutputVerifier.java) + +#### Description +This verification checks if a output entry is empty. + +#### Algorithm +``` +TODO +``` ## Decision Logic Level Verification - Classification: [DecisionLogicLevelVerification](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/classification/DecisionLogicLevelVerification.java) -### TODO... +### Subsumption Verification +- Type: [SubsumptionVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/SubsumptionVerification.java) +- Verifier: [SubsumptionVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/SubsumptionVerifier.java) + +#### Description +TODO + +#### Algorithm +``` +TODO +``` + +### Partial Reduction Verification +- Type: [PartialReductionVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/PartialReductionVerification.java) +- Verifier: [PartialReductionVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/PartialReductionVerifier.java) + +#### Description +TODO + +#### Algorithm +``` +TODO +``` + +### Overlapping Verification +- Type: [OverlappingVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/OverlappingVerification.java) +- Verifier: [OverlappingVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/OverlappingVerifier.java) + +#### Description +TODO + +#### Algorithm +``` +TODO +``` + +### Missing Rule Verification +- Type: [MissingRuleVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/MissingRuleVerification.java) +- Verifier: [MissingRuleVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/MissingRuleVerifier.java) + +#### Description +TODO + +#### Algorithm +``` +TODO +``` + +### Identical Business Rule Verification +- Type: [IdenticalBusinessRuleVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/IdenticalBusinessRuleVerification.java) +- Verifier: [IdenticalVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/IdenticalVerifier.java) +#### Description +TODO -## SyntaxLevelVerification +#### Algorithm +``` +TODO +``` + +### Equivalent String Verification +- Type: [EquivalentStringVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/EquivalentStringVerification.java) +- Verifier: [EquivalentVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/EquivalentVerifier.java) + +#### Description +TODO + +#### Algorithm +``` +TODO +``` + +## Syntax Level Verification - Classification: [SyntaxLevelVerification](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/classification/SyntaxLevelVerification.java) -### TODO... +### Date Format Verification +- Type: [DateVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/DateVerification.java) +- Verifier: [DateVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/DateVerifier.java) + +#### Description +This verification checks the correctness of the date format for all date entries. Each date should be in the format "data and time(yyyy-MM-ddThH:mm:ss)". + +#### Algorithm +``` +TODO +``` + +### Input Value Syntax Verification +- Type: [InputValueSyntaxVerification](/src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/types/InputValueSyntaxVerification.java) +- Verifier: [InputValueSyntaxVerifier](src/main/java/de/unikoblenz/fgbks/core/dmn/verification/verifier/impl/InputValueSyntaxVerifier.java) + +#### Description +This verification checks the correctness of the input formats for all input entries. They should have no syntax errors. + +For example: +A numeric input value must have one of the following formats: +- `= x` +- `<= x` +- `> x` +- `>= x` +- `[x..y]` +- `]x..y[` +- `[x..y[` +- `]x..y]` + +#### Algorithm +``` +TODO +``` -- GitLab