org.algorithmx.rules.model.RuleExecution Maven / Gradle / Ivy

Go to download
/**
 * This software is licensed under the Apache 2 license, quoted below.
 *
 * Copyright (c) 2019, algorithmx.org ([email protected])
 *
 * 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.
 */
package org.algorithmx.rules.model;

import org.algorithmx.rules.bind.ParameterResolver;
import org.algorithmx.rules.spring.util.Assert;

import java.lang.ref.WeakReference;
import java.util.Arrays;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

/**
 * Rule audit details. Contains all the details of a Rule Execution. It contains the details of the rule, all the associated
 * rule parameters, result or error and the time of the execution.
 *
 * @author Max Arulananthan
 * @since 1.0
 */
public final class RuleExecution implements Comparable {

    // Make sure we don't hold onto the actual rule definition
    private final WeakReference ruleDefinition;
    private final Map params = new LinkedHashMap<>();
    private final Set actions = new HashSet<>();
    private final Date time = new Date();
    private Boolean pass;
    private WeakReference error;

    public RuleExecution(RuleDefinition ruleDefinition, boolean pass, ParameterResolver.ParameterMatch...matches) {
        super();
        Assert.notNull(ruleDefinition, "ruleDefinition cannot be null.");
        this.ruleDefinition = new WeakReference<>(ruleDefinition);
        this.pass = pass;
        add(matches);
    }

    public RuleExecution(RuleDefinition ruleDefinition, Exception error, ParameterResolver.ParameterMatch...matches) {
        super();
        Assert.notNull(ruleDefinition, "ruleDefinition cannot be null.");
        this.ruleDefinition = new WeakReference<>(ruleDefinition);
        this.error = new WeakReference<>(error);
        add(matches);
    }

    /**
     * Returns the assocated Rule Definition. Could be null.
     *
     * @return rule definition (if avail).
     */
    public RuleDefinition getRuleDefinition() {
        return ruleDefinition.get();
    }

    /**
     * Adds an Action audit to the Rule Audit.
     *
     * @param action action audit to be added.
     */
    public void add(ActionExecution action) {
        Assert.notNull(action, "action cannot be null.");
        this.actions.add(action);
    }

    /**
     * Retrieves all the rule parameters.
     *
     * @return rule parameters.
     */
    public Map getParams() {
        return params;
    }

    /**
     * Did the Rule Condition pass?
     *
     * @return true if the rule passed; false otherwise.
     */
    public Boolean isSuccess() {
        return pass;
    }

    /**
     * Return the exception that occurred during the execution of the rule/
     * @return exception.
     */
    public Exception getError() {
        return error.get();
    }

    /**
     * Time when the Rule condition was run.
     *
     * @return time of Rule execution.
     */
    public Date getTime() {
        return time;
    }

    /**
     * Did an error happen during the execution.
     *
     * @return Rule execution error?
     */
    public boolean isError() {
        return error != null;
    }

    /**
     * Adds all the associated rule parameters.
     *
     * @param matches rule parameters.
     */
    private void add(ParameterResolver.ParameterMatch...matches) {
        if (matches == null || matches.length == 0) return;
        Arrays.stream(matches).forEach(this::add);
    }

    /**
     * Adds a rule parameter.
     *
     * @param match rule parameter.
     */
    private void add(ParameterResolver.ParameterMatch match) {
        if (match == null) return;
        Object value = match.getBinding().getValue();
        params.put(match.getDefinition().getName(), value != null
                ? value.toString() : null
                + "[Binding = " + match.getBinding().getName() + "]");
    }

    @Override
    public int compareTo(RuleExecution execution) {
        return getTime().compareTo(execution.getTime());
    }

    @Override
    public String toString() {
        return "RuleExecution{" +
                "ruleDefinition=" + (ruleDefinition.get() != null ? ruleDefinition.get().getName() : "n/a") +
                ", args=" + params +
                ", pass=" + pass +
                ", error=" + error +
                ", time=" + time +
                '}';
    }
}