org.smooks.cartridges.validation.ValidationSink Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smooks-validation-cartridge Show documentation
The Smooks Validation Cartridge builds on the functionality provided by the Rules Cartridge to provide rules-based fragment validation
The newest version!
/*-
 * ========================LICENSE_START=================================
 * smooks-validation-cartridge
 * %%
 * Copyright (C) 2020 Smooks
 * %%
 * Licensed under the terms of the Apache License Version 2.0, or
 * the GNU Lesser General Public License version 3.0 or later.
 *
 * SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later
 *
 * ======================================================================
 *
 * 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.
 *
 * ======================================================================
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * =========================LICENSE_END==================================
 */
package org.smooks.cartridges.validation;

import org.smooks.api.io.Sink;
import org.smooks.assertion.AssertArgument;

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

/**
 * ValidationResult object for capturing validation failures
 * at different levels.
 *
 * @author Daniel Bevenius
 */
public class ValidationSink implements Sink {
    /**
     * The validation result Map, keyed by OnFail Type.
     */
    private Map> results = new HashMap<>();

    /**
     * Fatal failure result.
     */
    private OnFailResult fatal;

    /**
     * Public default constructor.
     */
    public ValidationSink() {
        results.put(OnFail.OK, new ArrayList<>());
        results.put(OnFail.WARN, new ArrayList<>());
        results.put(OnFail.ERROR, new ArrayList<>());
    }

    /**
     * Gets all the {@link OnFailResult}s that were reported at the {@link OnFail#OK}
     * level.
     *
     * @return List {@link OnFailResult} reported at {@link OnFail#OK}.
     */
    public List getOKs() {
        return Collections.unmodifiableList(results.get(OnFail.OK));
    }

    /**
     * Gets all the {@link OnFailResult}s that were reported at the {@link OnFail#WARN}
     * level.
     *
     * @return List of {@link OnFailResult} reported at {@link OnFail#WARN}.
     */
    public List getWarnings() {
        return Collections.unmodifiableList(results.get(OnFail.WARN));
    }

    /**
     * Gets all the {@link OnFailResult}s that were reported at the {@link OnFail#ERROR}
     * level.
     *
     * @return List of {@link OnFailResult} reported at {@link OnFail#ERROR}.
     */
    public List getErrors() {
        return Collections.unmodifiableList(results.get(OnFail.ERROR));
    }

    /**
     * Gets the {@link OnFailResult} that was reported as a {@link OnFail#FATAL}.
     * 
     * Can only be one {@link OnFail#FATAL}.
     *
     * @return {@link OnFail#FATAL} {@link OnFailResult} if one occured, otherwise null.
     */
    public OnFailResult getFatal() {
        return fatal;
    }

    /**
     * Get the total number of failures on this {@link ValidationSink} instance.
     *
     * @return The total number of failures on this {@link ValidationSink} instance.
     */
    public int getNumFailures() {
        int numFailures = 0;
        Collection> values = results.values();

        for (List value : values) {
            numFailures += value.size();
        }

        if (fatal != null) {
            numFailures++;
        }

        return numFailures;
    }

    /**
     * Adds the {@link OnFailResult} with {@link OnFail} level passed in.
     *
     * @param result The {@link OnFailResult}. Cannot be null.
     * @param onFail The {@link OnFail} level for which this rule should be reported.
     */
    protected void addResult(final OnFailResult result, final OnFail onFail) {
        AssertArgument.isNotNull(result, "result");
        AssertArgument.isNotNull(onFail, "onFail");

        if (onFail == OnFail.FATAL) {
            fatal = result;
        } else {
            // Add the OnFailResult to the specific list.
            results.get(onFail).add(result);
        }
    }

    public String toString() {
        StringBuilder stringBuilder = new StringBuilder();

        stringBuilder.append("OK Failures:\n");
        addResultMessages(getOKs(), stringBuilder);
        stringBuilder.append("WARN Failures:\n");
        addResultMessages(getWarnings(), stringBuilder);
        stringBuilder.append("ERROR Failures:\n");
        addResultMessages(getErrors(), stringBuilder);
        stringBuilder.append("FATAL Failure:\n");
        if (fatal != null) {
            stringBuilder.append("\t" + fatal.getMessage() + "\n");
        } else {
            stringBuilder.append("\t(none)\n");
        }

        return stringBuilder.toString();
    }

    private void addResultMessages(List results, StringBuilder stringBuilder) {
        if (results.isEmpty()) {
            stringBuilder.append("\t(none)\n");
        } else {
            for (OnFailResult result : results) {
                stringBuilder.append("\t- " + result.getMessage() + "\n");
            }
        }
    }
}