com.regnosys.rosetta.common.validation.ValidationReport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rosetta-common Show documentation

Rune Common is a java library that is utilised by Rosetta Code Generators and models expressed in the Rosetta DSL.

There is a newer version: 11.27.1

package com.regnosys.rosetta.common.validation;

/*-
 * ==============
 * Rune Common
 * ==============
 * Copyright (C) 2018 - 2024 REGnosys
 * ==============
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.
 * ==============
 */

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.rosetta.lib.postprocess.PostProcessorReport;
import com.rosetta.model.lib.RosettaModelObject;
import com.rosetta.model.lib.process.Processor;
import com.rosetta.model.lib.validation.ValidationResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Comparator;
import java.util.List;
import java.util.stream.Collectors;

@SuppressWarnings("FieldCanBeLocal") // Used by Jackson
public class ValidationReport implements PostProcessorReport, Processor.Report {

	private static final Logger LOGGER = LoggerFactory.getLogger(ValidationReport.class);

	@JsonProperty
	private final List> validationResults;
	@JsonIgnore
	private final RosettaModelObject resultObject;

	public ValidationReport(RosettaModelObject resultObject, List> validationResults) {
		this.resultObject = resultObject;
		validationResults.sort(Comparator.comparing(ValidationResult::isSuccess, Boolean::compare));
		this.validationResults = validationResults;
	}

	@JsonProperty
	public boolean success() {
		return !failure();
	}

	public List> validationFailures() {
		return validationResults.stream()
				.filter(r -> !r.isSuccess())
				.collect(Collectors.toList());
	}

	public List> results() {
		return validationResults;
	}

	public void logReport() {
		for (ValidationResult validationResult : validationResults) {
			if (!validationResult.isSuccess()) {
				LOGGER.debug(validationResult.toString());
			} else {
				LOGGER.trace(validationResult.toString());
			}
		}
	}

	private boolean failure() {
		return !validationFailures().isEmpty();
	}

	public List> getValidationResults() {
		return validationResults;
	}

	@Override
	public RosettaModelObject getResultObject() {
		return resultObject;
	}
}