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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ruling-class Show documentation
Java Rule Engine for the masses
There is a newer version: 0.79.50
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.LinkedHashMap;
import java.util.Map;

public class ActionExecution implements Comparable {

    // Make sure we don't hold onto the actual action definition
    private final WeakReference actionDefinition;
    private final Map params = new LinkedHashMap<>();
    private final Date time = new Date();
    private WeakReference error;

    public ActionExecution(ActionDefinition actionDefinition, ParameterResolver.ParameterMatch...matches) {
        super();
        Assert.notNull(actionDefinition, "actionDefinition cannot be null.");
        this.actionDefinition = new WeakReference<>(actionDefinition);
        add(matches);
    }

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

    /**
     * Returns the associated Action Definition. Could be null.
     *
     * @return action definition (if avail).
     */
    public ActionDefinition getActionDefinition() {
        return actionDefinition.get();
    }

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

    /**
     * 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;
    }

    @Override
    public int compareTo(ActionExecution o) {
        return time.compareTo(o.getTime());
    }

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

    /**
     * Adds a action parameter.
     *
     * @param match action parameter match.
     */
    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 String toString() {
        return "ActionExecution{" +
                "actionDefinition=" + actionDefinition +
                ", params=" + params +
                ", time=" + time +
                ", error=" + error +
                '}';
    }
}