MetaTagsValidationEngine.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.radiology.report.template;

import java.util.ArrayList;
import java.util.List;

import org.jsoup.select.Elements;

/**
 * Validates <meta> tags of an Mrrt Report Template.
 */
class MetaTagsValidationEngine implements ValidationEngine<Elements> {
    
    
    static String SELECTOR_QUERY_META_ATTRIBUTE_CHARSET = "meta[charset]";
    
    static String SELECTOR_QUERY_META_ATTRIBUTE_NAME = "meta[name]";
    
    private List<ValidationRule<Elements>> rules;
    
    public MetaTagsValidationEngine() {
        rules = new ArrayList<>();
        rules.add(new ElementsExpressionValidationRule("One 'meta' element with attribute 'charset' expected",
                "radiology.MrrtReportTemplate.validation.error.meta.charset.occurence",
                SELECTOR_QUERY_META_ATTRIBUTE_CHARSET, subject -> subject.isEmpty() || subject.size() > 1));
        rules.add(
            new ElementsExpressionValidationRule("At least one 'meta' element encoding dublin core attributes expected",
                    "radiology.MrrtReportTemplate.validation.error.meta.dublinCore.missing",
                    SELECTOR_QUERY_META_ATTRIBUTE_NAME, subject -> subject.isEmpty()));
    }
    
    /**
     * @see org.openmrs.module.radiology.report.template.ValidationEngine#run(Object)
     * @should return validation result with no errors if subject passes all checks
     * @should return validation result with error for meta element charset attribute if not present in subject
     * @should return validation result with error for meta element charset attribute if present more than once in subject
     * @should return validation result with error for meta element dublin core if no meta element with name attribute is present in subject
     */
    @Override
    public ValidationResult run(Elements subject) {
        
        final ValidationResult validationResult = new ValidationResult();
        for (ValidationRule rule : rules) {
            rule.check(validationResult, subject);
        }
        return validationResult;
    }
}