org.psikeds.resolutionengine.rules.RuleStack.java Source code

Introduction

Here is the source code for org.psikeds.resolutionengine.rules.RuleStack.java

Source

/*******************************************************************************
 * psiKeds :- ps induced knowledge entity delivery system
 *
 * Copyright (c) 2013, 2014 Karsten Reincke, Marco Juliano, Deutsche Telekom AG
 *
 * This file is free software: you can redistribute
 * it and/or modify it under the terms of the
 * [x] GNU Affero General Public License
 * [ ] GNU General Public License
 * [ ] GNU Lesser General Public License
 * [ ] Creatice Commons ShareAlike License
 *
 * For details see file LICENSING in the top project directory
 *******************************************************************************/
package org.psikeds.resolutionengine.rules;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.springframework.util.StringUtils;

import org.psikeds.common.cache.LimitedHashMap;
import org.psikeds.resolutionengine.datalayer.vo.Rule;

/**
 * A stack of Rules; Depending on the current State of Resolution and
 * the corresponding Knowledge, all Rules are either on the Possible-
 * or the Obsolete- or the Triggered-Stack.
 * 
 * @author marco@juliano.de
 * 
 */
public class RuleStack extends LimitedHashMap<String, Rule> implements Serializable {

    private static final long serialVersionUID = 1L;

    public RuleStack() {
        super();
    }

    public RuleStack(final int maxSize) {
        super(maxSize);
    }

    // copy constructor
    public RuleStack(final RuleStack rules) {
        super(rules.getMaxSize());
        addRules(rules.getRules());
    }

    // ----------------------------------------------------------------

    public List<Rule> getRules() {
        return new ArrayList<Rule>(this.values());
    }

    public void setRules(final Collection<? extends Rule> rules) {
        clear();
        addRules(rules);
    }

    public void addRules(final Collection<? extends Rule> rules) {
        if (rules != null) {
            for (final Rule r : rules) {
                addRule(r);
            }
        }
    }

    public Rule addRule(final Rule r) {
        final String rid = (r == null ? null : r.getRuleID());
        return (StringUtils.isEmpty(rid) ? null : this.put(rid, r));
    }

    public Rule removeRule(final Rule r) {
        final String rid = (r == null ? null : r.getRuleID());
        return removeRule(rid);
    }

    public Rule removeRule(final String rid) {
        return (StringUtils.isEmpty(rid) ? null : this.remove(rid));
    }

    // ----------------------------------------------------------------

    public boolean containsRule(final Rule r) {
        return containsRule(r == null ? null : r.getRuleID());
    }

    public boolean containsRule(final String rid) {
        return (StringUtils.isEmpty(rid) ? false : this.containsKey(rid));
    }

    public Rule move2stack(final Rule r, final RuleStack destination) {
        final Rule orig = removeRule(r);
        return ((orig == null) || (destination == null) ? null : destination.addRule(r));
    }

    public Rule move2stack(final String rid, final RuleStack destination) {
        final Rule r = removeRule(rid);
        return ((r == null) || (destination == null) ? null : destination.addRule(r));
    }

    // ----------------------------------------------------------------

    public StringBuilder dumpRules(final StringBuilder sb, final boolean verbose) {
        sb.append("#Rules = ");
        sb.append(size());
        for (final Rule r : getRules()) {
            if (verbose) {
                sb.append('\n');
                sb.append(r);
            } else {
                sb.append(", ");
                sb.append(r.getRuleID());
            }
        }
        sb.append('\n');
        return sb;
    }
}