Skip to content

Latest commit

 

History

History
124 lines (114 loc) · 41.5 KB

net.adamec.lib.common.dmn.engine.md

File metadata and controls

124 lines (114 loc) · 41.5 KB

DMN Engine Documentation

Name Summary
net.adamec.lib.common.dmn.engine.engine.decisions
net.adamec.lib.common.dmn.engine.engine.decisions.expression
net.adamec.lib.common.dmn.engine.engine.decisions.table
net.adamec.lib.common.dmn.engine.engine.decisions.table.definition
net.adamec.lib.common.dmn.engine.engine.decisions.table.runtime
net.adamec.lib.common.dmn.engine.engine.definition
net.adamec.lib.common.dmn.engine.engine.definition.builder
net.adamec.lib.common.dmn.engine.engine.definition.extensions
net.adamec.lib.common.dmn.engine.engine.definition.extensions.diagram
net.adamec.lib.common.dmn.engine.engine.execution
net.adamec.lib.common.dmn.engine.engine.execution.context
net.adamec.lib.common.dmn.engine.engine.execution.result
net.adamec.lib.common.dmn.engine.parser
net.adamec.lib.common.dmn.engine.parser.dto
net.adamec.lib.common.dmn.engine.parser.dto.diagram
net.adamec.lib.common.dmn.engine.utils
Name Modifier Kind Summary
AllowedValues public Class Defines the list of allowed values for decision table inputs and outputs
Bounds public Class Represents dc:Bounds element of Shape in DMN XML
Decision public abstract Class Decision definition builder
Decision public Class Single decision within the DMN file It can be expression decision of decision table. Decision table is recognized by having the DecisionTable element, otherwise, the expression decision is expected with elements Expression and OutputVariable
Decision.Ref public Class Decision definition builder reference class
DecisionCatalog public Class Catalog holding the decision definition builders used in DmnDefinitionBuilder and their reference
DecisionRule public Class Decision table rule
DecisionTable public Class Decision table definition
DecisionTableInput public Class Decision table input definition
DecisionTableOutput public Class Decision table output definition
DecisionTableSerializable public Class Decision table (de)serialization proxy implemented to support the private getters in DecisionTable
Diagram public Class Represents dmndi:DMNDiagram element in DMN XML
DiDiagramExtension public Class Extension containing the DMN DI Diagram shapes with bounds for elements in definition
DiDiagramShapeExtension public Class Extension containing the DMN DI Diagram shape bounds for single element
DmnBuilderElement public abstract Class Base class for the elements of DMN definition DmnDefinitionBuilder
DmnBuilderElement<TBuilder,TResult> public abstract Class Base class for the buildable elements of DMN definition DmnDefinitionBuilder
DmnBuilderException public Class Exception thrown while building the DMN Definition
DmnDecision public abstract Class DMN Decision definition
DmnDecisionResult public Class Decision evaluation result (single or multiple)
DmnDecisionSingleResult public Class Single decision result
DmnDecisionTable public Class DMN Decision Table definition
DmnDecisionTable.PositiveRulesCollectValues private Class Container of aggregate values for positive rules when Collect hit policy is used.
DmnDecisionTableInput public Class Definition of decision table input - contains index (order), mapping to the source variable or source expression, and optional list of allowed values
DmnDecisionTableOutput public Class Definition of decision table output - contains index (order), mapping to the variable and optional list of allowed values
DmnDecisionTableRule public Class Definition of table rule
DmnDecisionTableRuleExecutionResults public Class Decision table rules execution results
DmnDecisionTableRuleExecutionResultsParallel public Class Decision table rules execution results
DmnDecisionTableRuleInput public Class Definition of decision table rule input - contains the input match evaluation expression and mapping to table input
DmnDecisionTableRuleOutput public Class Definition of decision table rule output - contains the calculation expression and mapping to table output
DmnDefinition public Class DMN model definition for execution engine - encapsulates Decisions, Variables (incl. Input data)
DmnDefinitionBuilder public Class Builder used to create DmnDefinition
DmnDefinitionFactory public Class Factory that validates and transforms the DmnModel to DmnDefinition that can be executed within DmnExecutionContext
DmnDi public Class Represents dmndi:DMNDI element in DMN XML
DmnExecutionContext public Class Context where is the DMN model executed
DmnExecutionContextFactory public static Class Factory creating the DMN Model execution context from DmnModel or DmnDefinition
DmnExecutionContextOptions public Class Execution configuration options
DmnExecutionSnapshot public Class Snapshot of execution context generated at the beginning of execution and after execution of decision. The snapshot (step) is generated for each decision in dependency tree
DmnExecutionSnapshots public Class Set of available snapshots
DmnExecutionVariable public Class Runtime (execution) variable
DmnExecutorException public Class Exception thrown while executing (evaluating) the DMN Model
DmnExpressionDecision public Class Expression decision definition
DmnExtendableExtensions public static Class IDmnExtendable extension methods to access the Extensions
DmnModel public Class Root of DMN definition XML - DMN Model
DmnParser public Class DMN Model XML parser
DmnParserException public Class Exception thrown while parsing the DMN Model
DmnResultVariable public Class Execution result variable
DmnUtils public Class DMN engine related utilities
DmnVariableDefinition public Class Definition of DMN model variable
Edge public Class Represents dmndi:DMNEdge element in DMN XML
Expression public Class Expression within the DMN definition file
ExpressionDecision public Class Expression decision definition builder Expression decision definition is built using the chain of builders provided as lambda/delegate when calling csharp DmnDefinitionBuilder.WithExpressionDecision . It has syntax csharp expressionDecision.Put("expression").To(outputVariableReference) . ExpressionDecision.ExpressionDecisionSrcBuilder provides Put(string) method and returns ExpressionDecision.ExpressionDecisionVarBuilder . ExpressionDecision.ExpressionDecisionVarBuilder provides To(Variable.Ref) method and returns &quot;final&quot; expression decision builder that can be used to configure the required inputs and decisions when needed and to fully build the expression decision
ExpressionDecision.ExpressionDecisionSrcBuilder public Class Helper builder used to configure the expression decision definition using the chain of builders. ExpressionDecision.ExpressionDecisionSrcBuilder provides Put(string) method to define the expression and returns ExpressionDecision.ExpressionDecisionVarBuilder used to define the output variable.
ExpressionDecision.ExpressionDecisionVarBuilder public Class Helper builder used to configure the expression decision definition using the chain of builders. ExpressionDecision.ExpressionDecisionVarBuilder provides To(Variable.Ref) method to define output variable and returns &quot;final&quot; expression decision builder that can be used to configure the required inputs and decisions when needed and to fully build the expression decision
IdedElement public abstract Class Element with id attribute
InformationRequirement public Class Defines the input or decision needed for the decision to be evaluated. The inputs are referenced by RequiredInput sub-element and decisions by RequiredDecision one. Exactly one of the sub element must be present
InformationRequirement.InformationRequirementItem public Class Required input or decision reference
InformationRequirementSerializable public Class Information Requirement (de)serialization proxy implemented to support the private getters in InformationRequirement
InputData public Class Input Data element Defines the input data item provided to the DMN model. The input parameter and related variable are defined by Name
NamedElement public abstract Class Element with id and name attributes
SfeelParser public Class S-FEEL simple parser
Shape public Class Represents dmndi:DMNShape element in DMN XML
TableDecision public Class Decision table definition builder
TableInput public Class Definition of decision table input - contains index (order), mapping to the source variable or source expression, and optional list of allowed values
TableInput.Ref public Class Table input definition builder reference class
TableOutput public Class Definition of decision table output - contains index (order), mapping to the variable and optional list of allowed values
TableOutput.Ref public Class Table output definition builder reference class
TableRule public Class Decision table rule definition builder Rule definition is built using the chain of builders provided as lambda/delegate when calling csharp TableDecision.WithRule . The table inputs and outputs must be defined in TableDecision builder first, as the rule builders must be provided with proper table input/output references. The builder chain provides methods to define the input conditions (When, When.And[.And], Always) and the output calculations (Then, Then.And[.And], SkipOutput) Syntax examples: csharp rule.When(input1Ref, "input 1 eval expression").Then(output1Ref, "output 1 calc expression") csharp rule.When(input1Ref, "input 1 eval expression").And(input2Ref, "input 2 eval expression").Then(output1Ref, "output 1 calc expression").And(output2Ref, "output 2 calc expression") csharp rule.Always().Then(output1Ref, "output 1 calc expression").And(output2Ref, "output 2 calc expression") csharp rule.When(input1Ref, "input 1 eval expression").SkipOutput() csharp rule.When(input1Ref, "input 1 eval expression").And(input2Ref, "input 2 eval expression").SkipOutput() csharp rule.Always().SkipOutput() TableRule.TableRuleInputBuilder provides When(TableInput.Ref, string) method to provide the first input condition and returns TableRule.TableRuleInputBuilder . TableRule.TableRuleInputBuilder provides Always() method to let the rule accept any input and returns TableRule.TableRuleThenOnlyBuilder . TableRule.TableRuleThenOrAndBuilder provides And(TableInput.Ref, string) method provide the additional input condition and returns TableRule.TableRuleThenOrAndBuilder . TableRule.TableRuleThenOrAndBuilder provides Then(TableOutput.Ref, string) method to provide the first output expression and returns TableRule.TableRuleAndOutputBuilder . TableRule.TableRuleThenOrAndBuilder provides SkipOutput() method to skip the output calculation and returns TableRule.TableRuleOutputBuilder . TableRule.TableRuleThenOnlyBuilder provides Then(TableOutput.Ref, string) method to provide the first output calculation and returns TableRule.TableRuleAndOutputBuilder . TableRule.TableRuleThenOnlyBuilder provides SkipOutput() method to skip the output calculation and returns TableRule.TableRuleOutputBuilder . TableRule.TableRuleAndOutputBuilder inherits from TableRule.TableRuleOutputBuilder and provides And(TableOutput.Ref, string) method to provide the additional output calculation and returns TableRule.TableRuleAndOutputBuilder . TableRule.TableRuleOutputBuilder is the final rule builder.
TableRule.TableRuleAndOutputBuilder public Class Helper builder used to configure the decision table rule definition using the chain of builders.
TableRule.TableRuleInputBuilder public Class Helper builder used to configure the decision table rule definition using the chain of builders.
TableRule.TableRuleOutputBuilder public Class Helper builder used to configure the decision table rule definition using the chain of builders.
TableRule.TableRuleThenOnlyBuilder public Class Helper builder used to configure the decision table rule definition using the chain of builders.
TableRule.TableRuleThenOrAndBuilder public Class Helper builder used to configure the decision table rule definition using the chain of builders.
Variable public Class Variable definition builder
Variable public Class Variable definition Used in expression decision definition to define the output variable
Variable.Ref public Class Variable definition builder reference class
VariableCatalog public Class Catalog holding the variable definitions (builders) used in DmnDefinitionBuilder and their reference
Waypoint public Class Represents di:waypoint element of Edge in DMN XML
IDmnDecision public abstract Interface Decision interface
IDmnDefinition public abstract Interface DMN model definition for execution engine - encapsulates Decisions, Variables and Input data
IDmnElement public abstract Interface Common properties for Decisions and Variables (also representing Input parameters)
IDmnExecutionContextOptions public abstract Interface Execution configuration options
IDmnExtendable public abstract Interface DMN definition classes that can have extensions
IDmnVariable public abstract Interface Read only definition DMN model variable
SFeel public Struct Helper struct for composing the SFeel input expressions
SFeel.Token public Struct Helper struct for composing the SFeel input expression tokens - the single "constant" or variable
CollectHitPolicyAggregationEnum public Enum Collect hit policy aggregation type
DmnParser.DmnVersionEnum public Enum DMN standard version to be used by DmnParser
HitPolicyEnum public Enum Decision Table hit policy - the hit policy specifies what the result of the decision table is in cases of overlapping rules, i.e. when more than one rule matches the input data.
InformationRequirementType public Enum Type of the dependency
ParsedExpressionCacheScopeEnum public Enum Scope of the parsed expression cache

Go to namespaces or types