de.viadee.bpm.vPAV.processing.checker.ProcessVariablesNameConventionChecker Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2017, viadee Unternehmensberatung GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    This product includes software developed by the viadee Unternehmensberatung GmbH.
 * 4. Neither the name of the viadee Unternehmensberatung GmbH nor the
 *    names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY  ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package de.viadee.bpm.vPAV.processing.checker;

import java.util.ArrayList;
import java.util.Collection;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.camunda.bpm.model.bpmn.instance.BaseElement;

import de.viadee.bpm.vPAV.BPMNScanner;
import de.viadee.bpm.vPAV.config.model.ElementConvention;
import de.viadee.bpm.vPAV.config.model.ElementFieldTypes;
import de.viadee.bpm.vPAV.config.model.Rule;
import de.viadee.bpm.vPAV.processing.model.data.BpmnElement;
import de.viadee.bpm.vPAV.processing.model.data.CheckerIssue;
import de.viadee.bpm.vPAV.processing.model.data.CriticalityEnum;
import de.viadee.bpm.vPAV.processing.model.data.ProcessVariable;
import de.viadee.bpm.vPAV.processing.model.data.VariableOperation;

/**
 *
 */
public class ProcessVariablesNameConventionChecker extends AbstractElementChecker {

    public ProcessVariablesNameConventionChecker(final Rule rule, final BPMNScanner bpmnScanner) {
        super(rule, bpmnScanner);
    }

    /**
     * Checks process variables in an bpmn element, whether they comply naming conventions
     *
     * @param element
     *            BpmnElement
     * @return issues collection of issues
     */
    @Override
    public Collection check(final BpmnElement element) {

        // analyse process variables are matching naming conventions
        final Collection issues = checkNamingConvention(element);

        return issues;
    }

    /**
     * Use regular expressions to check process variable conventions
     *
     * @param element
     * @return issues
     */
    private Collection checkNamingConvention(final BpmnElement element) {

        final Collection issues = new ArrayList();

        final Collection elementConventions = rule.getElementConventions();
        if (elementConventions != null) {
            for (final ElementConvention convention : elementConventions) {
                final Pattern pattern = Pattern.compile(convention.getPattern());
                final ElementFieldTypes fieldTypes = convention.getElementFieldTypes();
                final Collection fieldTypeItems = fieldTypes.getElementFieldTypes();
                for (final ProcessVariable variable : element.getProcessVariables().values()) {
                    if (variable.getOperation() == VariableOperation.WRITE) {
                        if (fieldTypeItems != null) {
                            boolean isInRange = false;
                            if (fieldTypes.isExcluded()) {
                                isInRange = !fieldTypeItems.contains(variable.getFieldType().name());
                            } else {
                                isInRange = fieldTypeItems.contains(variable.getFieldType().name());
                            }
                            if (isInRange) {
                                final Matcher patternMatcher = pattern.matcher(variable.getName());
                                if (!patternMatcher.matches()) {
                                    final BaseElement baseElement = element.getBaseElement();
                                    issues.add(new CheckerIssue(rule.getName(), CriticalityEnum.WARNING,
                                            element.getProcessdefinition(), variable.getResourceFilePath(),
                                            baseElement.getId(), baseElement.getAttributeValue("name"),
                                            variable.getName(), null, null,
                                            "process variable (" + variable.getName()
                                                    + ") is against the naming convention " + convention.getName()
                                                    + " (compare model: " + variable.getChapter() + ", "
                                                    + variable.getFieldType().getDescription() + ")"));
                                }
                            }
                        }
                    }
                }
            }
        }

        return issues;
    }
}