org.protempa.InverseIsAConsequence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation
Protempa Framework is the core of Protempa.
There is a newer version: 5.2-Alpha-2
/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package org.protempa;


import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.arp.javautil.collections.Collections;
import org.drools.WorkingMemory;
import org.drools.spi.Consequence;
import org.drools.spi.KnowledgeHelper;
import org.protempa.proposition.Proposition;

/**
 * Creates a new proposition that has an isA relationship with an existing
 * proposition.
 * 
 * @author Andrew Post
 * 
 */
class InverseIsAConsequence implements Consequence {

    private static final long serialVersionUID = 6157152982863451759L;
    
    private final Map> copiersMap;
    
    /**
     * Creates an instance with mappings from propositions to derived
     * propositions with an isA relationship, and a {@link DerivationsBuilder}
     * to maintain links between propositions and derived propositions.
     * 
     * @param inverseIsAPropIdMap a {@link Map>} from the 
     * id of a proposition to the ids of propositions that are derived from it.
     * Cannot be null.
     * @param listener a {@link DerivationsBuilder}. Cannot be 
     * null.
     */
    InverseIsAConsequence(Map> inverseIsAPropIdMap, 
            DerivationsBuilder listener) {
        assert inverseIsAPropIdMap != null : 
                "inverseIsAPropIdMap cannot be null";
        assert listener != null : "listener cannot be null";
        this.copiersMap = new HashMap<>();
        for (Map.Entry> me : 
                inverseIsAPropIdMap.entrySet()) {
            List targetPropIds = me.getValue();
            List pcs = 
                    new ArrayList<>(targetPropIds.size());
            for (String targetPropId : targetPropIds) {
                pcs.add(new PropositionCopier(targetPropId, listener));
            }
            Collections.putListMult(this.copiersMap, me.getKey(), pcs);
        }
    }

    /**
     * Uses the inverseIsAPropIdMap to create one or more
     * derived propositions from the proposition that fired this rule.
     * 
     * @param knowledgeHelper a {@link KnowledgeHelper}.
     * @param workingMemory the {@link WorkingMemory}.
     */
    @Override
    public void evaluate(KnowledgeHelper knowledgeHelper,
            WorkingMemory workingMemory) {
        Proposition prop = (Proposition) workingMemory.getObject(
                knowledgeHelper.getTuple().get(0));
        List copiers = this.copiersMap.get(prop.getId());
        assert copiers != null : "copiers should never be null";
        for (PropositionCopier copier : copiers) {
            copier.grab(workingMemory);
            prop.accept(copier);
            copier.release();
        }
    }
}