org.camunda.bpm.model.dmn.instance.Rule Java Examples

@Deployment(resources = "org/camunda/bpm/engine/test/repository/one.dmn")
public void testRepositoryService() {
  String decisionDefinitionId = repositoryService
    .createDecisionDefinitionQuery()
    .decisionDefinitionKey(DECISION_KEY)
    .singleResult()
    .getId();

  DmnModelInstance modelInstance = repositoryService.getDmnModelInstance(decisionDefinitionId);
  assertNotNull(modelInstance);

  Collection<Decision> decisions = modelInstance.getModelElementsByType(Decision.class);
  assertEquals(1, decisions.size());

  Collection<DecisionTable> decisionTables = modelInstance.getModelElementsByType(DecisionTable.class);
  assertEquals(1, decisionTables.size());

  Collection<Input> inputs = modelInstance.getModelElementsByType(Input.class);
  assertEquals(1, inputs.size());

  Collection<Output> outputs = modelInstance.getModelElementsByType(Output.class);
  assertEquals(1, outputs.size());

  Collection<Rule> rules = modelInstance.getModelElementsByType(Rule.class);
  assertEquals(2, rules.size());
}
 

@Test
@DmnModelResource(resource = EXPRESSION_LANGUAGE_DMN)
public void shouldReadExpressionLanguage() {
  Definitions definitions = modelInstance.getDefinitions();
  assertThat(definitions.getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);

  DecisionTable decisionTable = modelInstance.getModelElementById("decisionTable");
  Input input = decisionTable.getInputs().iterator().next();
  assertThat(input.getInputExpression().getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);
  assertThat(input.getInputValues().getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);
  Output output = decisionTable.getOutputs().iterator().next();
  assertThat(output.getOutputValues().getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);

  Rule rule = decisionTable.getRules().iterator().next();
  InputEntry inputEntry = rule.getInputEntries().iterator().next();
  assertThat(inputEntry.getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);
  OutputEntry outputEntry = rule.getOutputEntries().iterator().next();
  assertThat(outputEntry.getExpressionLanguage()).isEqualTo(EXPRESSION_LANGUAGE);
}
 

protected static Map<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler> getDefaultElementTransformHandlers() {
  Map<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler> handlers = new HashMap<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler>();

  handlers.put(Definitions.class, new DmnDecisionRequirementsGraphTransformHandler());
  handlers.put(Decision.class, new DmnDecisionTransformHandler());

  handlers.put(DecisionTable.class, new DmnDecisionTableTransformHandler());
  handlers.put(Input.class, new DmnDecisionTableInputTransformHandler());
  handlers.put(InputExpression.class, new DmnDecisionTableInputExpressionTransformHandler());
  handlers.put(Output.class, new DmnDecisionTableOutputTransformHandler());
  handlers.put(Rule.class, new DmnDecisionTableRuleTransformHandler());
  handlers.put(InputEntry.class, new DmnDecisionTableConditionTransformHandler());
  handlers.put(OutputEntry.class, new DmnLiternalExpressionTransformHandler());

  handlers.put(LiteralExpression.class, new DmnLiternalExpressionTransformHandler());
  handlers.put(Variable.class, new DmnVariableTransformHandler());

  return handlers;
}
 

protected static Map<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler> getDefaultElementTransformHandlers() {
  Map<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler> handlers = new HashMap<Class<? extends DmnModelElementInstance>, DmnElementTransformHandler>();

  handlers.put(Definitions.class, new DmnDecisionRequirementsGraphTransformHandler());
  handlers.put(Decision.class, new DmnDecisionTransformHandler());

  handlers.put(DecisionTable.class, new DmnDecisionTableTransformHandler());
  handlers.put(Input.class, new DmnDecisionTableInputTransformHandler());
  handlers.put(InputExpression.class, new DmnDecisionTableInputExpressionTransformHandler());
  handlers.put(Output.class, new DmnDecisionTableOutputTransformHandler());
  handlers.put(Rule.class, new DmnDecisionTableRuleTransformHandler());
  handlers.put(InputEntry.class, new DmnDecisionTableConditionTransformHandler());
  handlers.put(OutputEntry.class, new DmnLiternalExpressionTransformHandler());

  handlers.put(LiteralExpression.class, new DmnLiternalExpressionTransformHandler());
  handlers.put(Variable.class, new DmnVariableTransformHandler());

  return handlers;
}
 

@Test
public void testConversionWithRanges() {
  XlsxConverter converter = new XlsxConverter();
  InputStream inputStream = TestHelper.getClassPathResource("test5.xlsx");
  DmnModelInstance dmnModelInstance = converter.convert(inputStream);
  assertThat(dmnModelInstance).isNotNull();

  DecisionTable table = TestHelper.assertAndGetSingleDecisionTable(dmnModelInstance);
  assertThat(table).isNotNull();
  assertThat(table.getInputs()).hasSize(1);
  assertThat(table.getOutputs()).hasSize(1);
  assertThat(table.getRules()).hasSize(4);

  Rule firstRule = table.getRules().iterator().next();

  InputEntry inputEntry = firstRule.getInputEntries().iterator().next();
  String firstInput = inputEntry.getTextContent();
  assertThat(firstInput).isEqualTo("[1..2]");
}
 

protected DmnDecisionTableRuleImpl transformDecisionTableRule(Rule rule) {
  DmnElementTransformHandler<Rule, DmnDecisionTableRuleImpl> handler = handlerRegistry.getHandler(Rule.class);
  DmnDecisionTableRuleImpl dmnRule = handler.handleElement(this, rule);

  // validate rule id
  if (dmnRule.getId() == null) {
    throw LOG.decisionTableRuleIdIsMissing(decision, dmnRule);
  }

  List<DmnDecisionTableInputImpl> inputs = this.decisionTable.getInputs();
  List<InputEntry> inputEntries = new ArrayList<InputEntry>(rule.getInputEntries());
  if (inputs.size() != inputEntries.size()) {
    throw LOG.differentNumberOfInputsAndInputEntries(inputs.size(), inputEntries.size(), dmnRule);
  }

  for (InputEntry inputEntry : inputEntries) {
    parent = dmnRule;

    DmnExpressionImpl condition = transformInputEntry(inputEntry);
    dmnRule.getConditions().add(condition);
  }

  List<DmnDecisionTableOutputImpl> outputs = this.decisionTable.getOutputs();
  List<OutputEntry> outputEntries = new ArrayList<OutputEntry>(rule.getOutputEntries());
  if (outputs.size() != outputEntries.size()) {
    throw LOG.differentNumberOfOutputsAndOutputEntries(outputs.size(), outputEntries.size(), dmnRule);
  }

  for (OutputEntry outputEntry : outputEntries) {
    parent = dmnRule;
    DmnExpressionImpl conclusion = transformOutputEntry(outputEntry);
    dmnRule.getConclusions().add(conclusion);
  }

  return dmnRule;
}
 

public static void registerType(ModelBuilder modelBuilder) {
  ModelElementTypeBuilder typeBuilder = modelBuilder.defineType(Rule.class, DMN_ELEMENT_RULE)
    .namespaceUri(DMN11_NS)
    .extendsType(DecisionRule.class)
    .instanceProvider(new ModelTypeInstanceProvider<Rule>() {
      public Rule newInstance(ModelTypeInstanceContext instanceContext) {
        return new RuleImpl(instanceContext);
      }
    });

  typeBuilder.build();
}
 

public static void registerType(ModelBuilder modelBuilder) {
  ModelElementTypeBuilder typeBuilder = modelBuilder.defineType(DecisionTable.class, DMN_ELEMENT_DECISION_TABLE)
    .namespaceUri(DMN11_NS)
    .extendsType(Expression.class)
    .instanceProvider(new ModelTypeInstanceProvider<DecisionTable>() {
      public DecisionTable newInstance(ModelTypeInstanceContext instanceContext) {
        return new DecisionTableImpl(instanceContext);
      }
    });

  hitPolicyAttribute = typeBuilder.namedEnumAttribute(DMN_ATTRIBUTE_HIT_POLICY, HitPolicy.class)
    .defaultValue(HitPolicy.UNIQUE)
    .build();

  aggregationAttribute = typeBuilder.enumAttribute(DMN_ATTRIBUTE_AGGREGATION, BuiltinAggregator.class)
    .build();

  preferredOrientationAttribute = typeBuilder.namedEnumAttribute(DMN_ATTRIBUTE_PREFERRED_ORIENTATION, DecisionTableOrientation.class)
    .defaultValue(DecisionTableOrientation.Rule_as_Row)
    .build();

  outputLabelAttribute = typeBuilder.stringAttribute(DMN_ATTRIBUTE_OUTPUT_LABEL)
    .build();

  SequenceBuilder sequenceBuilder = typeBuilder.sequence();

  inputCollection = sequenceBuilder.elementCollection(Input.class)
    .build();

  outputCollection = sequenceBuilder.elementCollection(Output.class)
    .required()
    .build();

  ruleCollection = sequenceBuilder.elementCollection(Rule.class)
    .build();

  typeBuilder.build();
}
 

@Test
public void shouldVerifyTransformedRule() {
  dmnEngine.parseDecisionRequirementsGraph(IoUtil.fileAsStream(DECISION_TRANSFORM_DMN));
  DmnDecisionTableRuleImpl dmnRule = listener.getDmnRule();
  Rule rule = listener.getRule();

  assertThat(dmnRule.getId())
    .isEqualTo(rule.getId())
    .isEqualTo("rule");
  
}
 

protected DmnDecisionTableRuleImpl createFromRule(DmnElementTransformContext context, Rule rule) {
  DmnDecisionTableRuleImpl decisionTableRule = createDmnElement(context, rule);

  decisionTableRule.setId(rule.getId());
  decisionTableRule.setName(rule.getLabel());

  return decisionTableRule;
}
 

protected DmnDecisionTableRuleImpl transformDecisionTableRule(Rule rule) {
  DmnElementTransformHandler<Rule, DmnDecisionTableRuleImpl> handler = handlerRegistry.getHandler(Rule.class);
  DmnDecisionTableRuleImpl dmnRule = handler.handleElement(this, rule);

  // validate rule id
  if (dmnRule.getId() == null) {
    throw LOG.decisionTableRuleIdIsMissing(decision, dmnRule);
  }

  List<DmnDecisionTableInputImpl> inputs = this.decisionTable.getInputs();
  List<InputEntry> inputEntries = new ArrayList<InputEntry>(rule.getInputEntries());
  if (inputs.size() != inputEntries.size()) {
    throw LOG.differentNumberOfInputsAndInputEntries(inputs.size(), inputEntries.size(), dmnRule);
  }

  for (InputEntry inputEntry : inputEntries) {
    parent = dmnRule;

    DmnExpressionImpl condition = transformInputEntry(inputEntry);
    dmnRule.getConditions().add(condition);
  }

  List<DmnDecisionTableOutputImpl> outputs = this.decisionTable.getOutputs();
  List<OutputEntry> outputEntries = new ArrayList<OutputEntry>(rule.getOutputEntries());
  if (outputs.size() != outputEntries.size()) {
    throw LOG.differentNumberOfOutputsAndOutputEntries(outputs.size(), outputEntries.size(), dmnRule);
  }

  for (OutputEntry outputEntry : outputEntries) {
    parent = dmnRule;
    DmnExpressionImpl conclusion = transformOutputEntry(outputEntry);
    dmnRule.getConclusions().add(conclusion);
  }

  return dmnRule;
}
 

@Test
public void testConversionWithComplexHeaders() {
  XlsxConverter converter = new XlsxConverter();
  converter.setIoDetectionStrategy(new AdvancedSpreadsheetAdapter());
  InputStream inputStream = TestHelper.getClassPathResource("test6.xlsx");
  DmnModelInstance dmnModelInstance = converter.convert(inputStream);
  assertThat(dmnModelInstance).isNotNull();

  DecisionTable table = TestHelper.assertAndGetSingleDecisionTable(dmnModelInstance);
  assertThat(table).isNotNull();
  assertThat(table.getInputs()).hasSize(2);
  assertThat(table.getOutputs()).hasSize(2);
  assertThat(table.getRules()).hasSize(2);
  assertThat(table.getHitPolicy()).isEqualTo(HitPolicy.FIRST);

  Iterator<Input> inputIterator = table.getInputs().iterator();
  Input input = inputIterator.next();

  assertThat(input.getId()).isEqualTo("input1");
  assertThat(input.getLabel()).isEqualTo("InputLabel1");
  assertThat(input.getInputExpression().getTypeRef()).isEqualTo("string");
  assertThat(input.getTextContent()).isEqualTo("Exp1");

  input = inputIterator.next();
  assertThat(input.getId()).isEqualTo("input2");
  assertThat(input.getLabel()).isEqualTo("InputLabel2");
  assertThat(input.getInputExpression().getTypeRef()).isEqualTo("integer");
  assertThat(input.getInputExpression().getExpressionLanguage()).isEqualTo("javascript");
  assertThat(input.getInputExpression().getTextContent()).isEqualTo(JAVASCRIPT_SNIPPET);

  Iterator<Rule> ruleIterator = table.getRules().iterator();
  Rule rule = ruleIterator.next();
  assertThat(rule.getDescription().getTextContent()).isEqualTo("Comment1");

  InputEntry inputEntry = rule.getInputEntries().iterator().next();
  assertThat(inputEntry.getTextContent()).isEqualTo("\"Foo\"");

  rule = ruleIterator.next();
  assertThat(rule.getDescription().getTextContent()).isEqualTo("Another Comment");
}
 

@Test
public void shouldVerifyTransformedRule() {
  dmnEngine.parseDecisionRequirementsGraph(IoUtil.fileAsStream(DECISION_TRANSFORM_DMN));
  DmnDecisionTableRuleImpl dmnRule = listener.getDmnRule();
  Rule rule = listener.getRule();

  assertThat(dmnRule.getId())
    .isEqualTo(rule.getId())
    .isEqualTo("rule");
  
}
 

protected DmnDecisionTableRuleImpl createFromRule(DmnElementTransformContext context, Rule rule) {
  DmnDecisionTableRuleImpl decisionTableRule = createDmnElement(context, rule);

  decisionTableRule.setId(rule.getId());
  decisionTableRule.setName(rule.getLabel());

  return decisionTableRule;
}
 

protected DmnDecisionTableRuleImpl createDmnElement(DmnElementTransformContext context, Rule rule) {
  return new DmnDecisionTableRuleImpl();
}
 

protected DmnDecisionTableImpl transformDecisionTable(DecisionTable decisionTable) {
  DmnElementTransformHandler<DecisionTable, DmnDecisionTableImpl> handler = handlerRegistry.getHandler(DecisionTable.class);
  DmnDecisionTableImpl dmnDecisionTable = handler.handleElement(this, decisionTable);

  for (Input input : decisionTable.getInputs()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableInputImpl dmnInput = transformDecisionTableInput(input);
    if (dmnInput != null) {
      dmnDecisionTable.getInputs().add(dmnInput);
      notifyTransformListeners(input, dmnInput);
    }
  }

  boolean needsName = decisionTable.getOutputs().size() > 1;
  Set<String> usedNames = new HashSet<String>();
  for (Output output : decisionTable.getOutputs()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableOutputImpl dmnOutput = transformDecisionTableOutput(output);
    if (dmnOutput != null) {
      // validate output name
      String outputName = dmnOutput.getOutputName();
      if (needsName && outputName == null) {
        throw LOG.compoundOutputsShouldHaveAnOutputName(dmnDecisionTable, dmnOutput);
      }
      if (usedNames.contains(outputName)) {
        throw LOG.compoundOutputWithDuplicateName(dmnDecisionTable, dmnOutput);
      }
      usedNames.add(outputName);

      dmnDecisionTable.getOutputs().add(dmnOutput);
      notifyTransformListeners(output, dmnOutput);
    }
  }

  for (Rule rule : decisionTable.getRules()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableRuleImpl dmnRule = transformDecisionTableRule(rule);
    if (dmnRule != null) {
      dmnDecisionTable.getRules().add(dmnRule);
      notifyTransformListeners(rule, dmnRule);
    }
  }

  return dmnDecisionTable;
}
 

@Test
public void shouldWriteExpressionLanguage() throws Exception {
  modelInstance = Dmn.createEmptyModel();
  Definitions definitions = generateNamedElement(Definitions.class, "definitions");
  definitions.setNamespace(TEST_NAMESPACE);
  definitions.setExpressionLanguage(EXPRESSION_LANGUAGE);
  modelInstance.setDocumentElement(definitions);

  Decision decision = generateNamedElement(Decision.class, "Check Order");
  definitions.addChildElement(decision);

  DecisionTable decisionTable = generateElement(DecisionTable.class);
  decision.addChildElement(decisionTable);

  Input input = generateElement(Input.class);
  decisionTable.getInputs().add(input);
  InputExpression inputExpression = generateElement(InputExpression.class);
  inputExpression.setExpressionLanguage(EXPRESSION_LANGUAGE);
  input.setInputExpression(inputExpression);
  InputValues inputValues = generateElement(InputValues.class);
  inputValues.setExpressionLanguage(EXPRESSION_LANGUAGE);
  inputValues.setText(generateElement(Text.class));
  input.setInputValues(inputValues);

  Output output = generateElement(Output.class);
  decisionTable.getOutputs().add(output);
  OutputValues outputValues = generateElement(OutputValues.class);
  outputValues.setExpressionLanguage(EXPRESSION_LANGUAGE);
  outputValues.setText(generateElement(Text.class));
  output.setOutputValues(outputValues);

  Rule rule = generateElement(Rule.class);
  decisionTable.getRules().add(rule);
  InputEntry inputEntry = generateElement(InputEntry.class);
  inputEntry.setExpressionLanguage(EXPRESSION_LANGUAGE);
  inputEntry.setText(generateElement(Text.class));
  rule.getInputEntries().add(inputEntry);
  OutputEntry outputEntry = generateElement(OutputEntry.class);
  outputEntry.setExpressionLanguage(EXPRESSION_LANGUAGE);
  rule.getOutputEntries().add(outputEntry);

  assertModelEqualsFile(EXPRESSION_LANGUAGE_DMN);
}
 

protected void notifyTransformListeners(Rule rule, DmnDecisionTableRuleImpl dmnRule) {
  for (DmnTransformListener transformListener : transformListeners) {
    transformListener.transformDecisionTableRule(rule, dmnRule);
  }
}
 

/**
 * <p>There is an issue in JDK 9+ that changes how CDATA section are serialized:
 *
 * <p>https://bugs.java.com/bugdatabase/view_bug.do?bug_id=JDK-8223291
 *
 * <p>&lt; JDK9:
 *
 * <pre>
 * &lt;inputEntry id="inputEntry1"&gt;
 *   &lt;text&gt;&lt;![CDATA[&gt;= 1000]]&gt;&lt;/text&gt;
 * &lt;/inputEntry&gt;
 * </pre>
 *
 * <p>(the text element has one child node, a CDATA section)
 *
 * <p>&gt;= JDK9:
 *
 * <pre>
 * &lt;inputEntry id="inputEntry1"&gt;
 *   &lt;text&gt;
 *     &lt;![CDATA[&gt;= 1000]]&gt;
 *   &lt;/text&gt;
 * &lt;/inputEntry&gt;
 * </pre>
 *
 * <p>(the text element has three child nodes, a text node, a CDATA section and another text node)
 *
 * <p>This test ensures, that a JDK9-formatted model can be read
 * and the text content method returns the CDATA value only
 */
@Test
public void shouldReadJDK9StyleModel()
{
  DmnModelInstance modelInstance =
      Dmn.readModelFromStream(ExampleCompatibilityTest.class.getResourceAsStream("JDK9-style-CDATA.dmn"));

  Decision decision = (Decision) modelInstance.getDefinitions().getDrgElements().iterator().next();

  DecisionTable decisionTable = (DecisionTable) decision.getExpression();

  Rule rule = decisionTable.getRules().iterator().next();
  InputEntry inputEntry = rule.getInputEntries().iterator().next();
  String textContent = inputEntry.getText().getTextContent();
  assertThat(textContent).isEqualTo(">= 1000");
}
 

public DmnDecisionTableRuleImpl handleElement(DmnElementTransformContext context, Rule rule) {
  return createFromRule(context, rule);
}
 

public Collection<Rule> getRules() {
  return ruleCollection.get(this);
}
 

public void transformDecisionTableRule(Rule rule, DmnDecisionTableRuleImpl dmnRule) {
  this.rule = rule;
  this.dmnRule = dmnRule;
}
 

public Rule getRule() {
  return rule;
}
 

public void transformDecisionTableRule(Rule rule, DmnDecisionTableRuleImpl dmnRule) {
  this.rule = rule;
  this.dmnRule = dmnRule;
}
 

protected DmnDecisionTableRuleImpl createDmnElement(DmnElementTransformContext context, Rule rule) {
  return new DmnDecisionTableRuleImpl();
}
 

public DmnDecisionTableRuleImpl handleElement(DmnElementTransformContext context, Rule rule) {
  return createFromRule(context, rule);
}
 

protected void notifyTransformListeners(Rule rule, DmnDecisionTableRuleImpl dmnRule) {
  for (DmnTransformListener transformListener : transformListeners) {
    transformListener.transformDecisionTableRule(rule, dmnRule);
  }
}
 

public Rule getRule() {
  return rule;
}
 

protected DmnDecisionTableImpl transformDecisionTable(DecisionTable decisionTable) {
  DmnElementTransformHandler<DecisionTable, DmnDecisionTableImpl> handler = handlerRegistry.getHandler(DecisionTable.class);
  DmnDecisionTableImpl dmnDecisionTable = handler.handleElement(this, decisionTable);

  for (Input input : decisionTable.getInputs()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableInputImpl dmnInput = transformDecisionTableInput(input);
    if (dmnInput != null) {
      dmnDecisionTable.getInputs().add(dmnInput);
      notifyTransformListeners(input, dmnInput);
    }
  }

  boolean needsName = decisionTable.getOutputs().size() > 1;
  Set<String> usedNames = new HashSet<String>();
  for (Output output : decisionTable.getOutputs()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableOutputImpl dmnOutput = transformDecisionTableOutput(output);
    if (dmnOutput != null) {
      // validate output name
      String outputName = dmnOutput.getOutputName();
      if (needsName && outputName == null) {
        throw LOG.compoundOutputsShouldHaveAnOutputName(dmnDecisionTable, dmnOutput);
      }
      if (usedNames.contains(outputName)) {
        throw LOG.compoundOutputWithDuplicateName(dmnDecisionTable, dmnOutput);
      }
      usedNames.add(outputName);

      dmnDecisionTable.getOutputs().add(dmnOutput);
      notifyTransformListeners(output, dmnOutput);
    }
  }

  for (Rule rule : decisionTable.getRules()) {
    parent = dmnDecisionTable;
    this.decisionTable = dmnDecisionTable;
    DmnDecisionTableRuleImpl dmnRule = transformDecisionTableRule(rule);
    if (dmnRule != null) {
      dmnDecisionTable.getRules().add(dmnRule);
      notifyTransformListeners(rule, dmnRule);
    }
  }

  return dmnDecisionTable;
}
 

/**
 * Notified after a DMN decision table rule was transformed
 *
 * @param rule the rule from the DMN model instance
 * @param dmnRule the transformed {@link DmnDecisionTableRuleImpl}
 */
void transformDecisionTableRule(Rule rule, DmnDecisionTableRuleImpl dmnRule);