org.camunda.bpm.engine.impl.migration.validation.instruction.ValidatingMigrationInstructions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation
There is a newer version: 7.22.0-alpha1
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.impl.migration.validation.instruction;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;

import org.camunda.bpm.engine.impl.pvm.process.ScopeImpl;
import org.camunda.bpm.engine.impl.util.CollectionUtil;
import org.camunda.bpm.engine.migration.MigrationInstruction;

/**
 * @author Thorben Lindhauer
 *
 */
public class ValidatingMigrationInstructions {

  protected Collection instructions;
  protected Map> instructionsBySourceScope;
  protected Map> instructionsByTargetScope;

  public ValidatingMigrationInstructions(Collection instructions) {
    this.instructions = instructions;
    instructionsBySourceScope = new HashMap>();
    instructionsByTargetScope = new HashMap>();

    for (ValidatingMigrationInstruction instruction : instructions) {
      indexInstruction(instruction);
    }
  }

  public ValidatingMigrationInstructions() {
    this(new HashSet());
  }

  public void addInstruction(ValidatingMigrationInstruction instruction) {
    instructions.add(instruction);
    indexInstruction(instruction);
  }

  public void addAll(List instructions) {
    for (ValidatingMigrationInstruction instruction : instructions) {
      addInstruction(instruction);
    }
  }

  protected void indexInstruction(ValidatingMigrationInstruction instruction) {
    CollectionUtil.addToMapOfLists(instructionsBySourceScope, instruction.getSourceActivity(), instruction);
    CollectionUtil.addToMapOfLists(instructionsByTargetScope, instruction.getTargetActivity(), instruction);
  }

  public List getInstructions() {
    return new ArrayList(instructions);
  }

  public List getInstructionsBySourceScope(ScopeImpl scope) {
    List instructions = instructionsBySourceScope.get(scope);

    if (instructions == null) {
      return Collections.emptyList();
    }
    else {
      return instructions;
    }
  }

  public List getInstructionsByTargetScope(ScopeImpl scope) {
    List instructions = instructionsByTargetScope.get(scope);

    if (instructions == null) {
      return Collections.emptyList();
    }
    else {
      return instructions;
    }
  }

  public void filterWith(List validators) {
    List validInstructions = new ArrayList();

    for (ValidatingMigrationInstruction instruction : instructions) {
      if (isValidInstruction(instruction, this, validators)) {
        validInstructions.add(instruction);
      }
    }

    instructionsBySourceScope.clear();
    instructionsByTargetScope.clear();
    instructions.clear();

    for (ValidatingMigrationInstruction validInstruction : validInstructions) {
      addInstruction(validInstruction);
    }
  }

  public List asMigrationInstructions() {
    List instructions = new ArrayList();

    for (ValidatingMigrationInstruction instruction : this.instructions) {
      instructions.add(instruction.toMigrationInstruction());
    }

    return instructions;
  }

  public boolean contains(ValidatingMigrationInstruction instruction) {
    return instructions.contains(instruction);
  }

  public boolean containsInstructionForSourceScope(ScopeImpl sourceScope) {
    return instructionsBySourceScope.containsKey(sourceScope);
  }

  protected boolean isValidInstruction(ValidatingMigrationInstruction instruction, ValidatingMigrationInstructions instructions, List migrationInstructionValidators) {
    return !validateInstruction(instruction, instructions, migrationInstructionValidators).hasFailures();
  }

  protected MigrationInstructionValidationReportImpl validateInstruction(ValidatingMigrationInstruction instruction, ValidatingMigrationInstructions instructions, List migrationInstructionValidators) {
    MigrationInstructionValidationReportImpl validationReport = new MigrationInstructionValidationReportImpl(instruction.toMigrationInstruction());
    for (MigrationInstructionValidator migrationInstructionValidator : migrationInstructionValidators) {
      migrationInstructionValidator.validate(instruction, instructions, validationReport);
    }
    return validationReport;
  }
}