001/**
002 * CompromiseDrivenSelection.java
003 * jCOLIBRI2 framework. 
004 * @author Juan A. Recio-Garc�a.
005 * GAIA - Group for Artificial Intelligence Applications
006 * http://gaia.fdi.ucm.es
007 * 21/11/2007
008 */
009package es.ucm.fdi.gaia.jcolibri.method.retrieve.selection.compromiseDriven;
010
011import org.apache.logging.log4j.LogManager;
012
013import es.ucm.fdi.gaia.jcolibri.cbrcore.Attribute;
014import es.ucm.fdi.gaia.jcolibri.cbrcore.CBRCase;
015import es.ucm.fdi.gaia.jcolibri.cbrcore.CBRQuery;
016import es.ucm.fdi.gaia.jcolibri.exception.NoApplicableFilterPredicateException;
017import es.ucm.fdi.gaia.jcolibri.method.retrieve.RetrievalResult;
018import es.ucm.fdi.gaia.jcolibri.method.retrieve.FilterBasedRetrieval.FilterConfig;
019import es.ucm.fdi.gaia.jcolibri.method.retrieve.FilterBasedRetrieval.predicates.FilterPredicate;
020import es.ucm.fdi.gaia.jcolibri.method.retrieve.selection.SelectCases;
021import es.ucm.fdi.gaia.jcolibri.util.AttributeUtils;
022
023import java.util.*;
024
025/**
026 * Cases selection approach that chooses cases according to their compromises with the user's query.
027 * The compromises are those attributes that do not satisfy the user's requirement.
028 * That way cases are selected according to the number of compromises and their similarity.
029 * 
030 * See: 
031 * D. McSherry. Similarity and compromise. In Case-Based Reasoning Research
032 * and Development, 5th International Conference on Case-Based Reasoning,
033 * ICCBR, pages 291-305, 2003.
034 * 
035 * @author Juan A. Recio-Garcia
036 * @author Developed at University College Cork (Ireland) in collaboration with Derek Bridge.
037 * @version 1.0
038 */
039public class CompromiseDrivenSelection
040{
041    /**
042     * Returns a list of cases according with their compromises and similarity
043     * @param query to compare with
044     * @param cases to compare
045     * @param preferences define the predicates that evaluate the user preferences
046     * @return a CDRSet object that stores the list of selected cases, the "like" sets and the "covered" sets (see paper for details).
047     */
048    public static CDRSet CDR(CBRQuery query, Collection<RetrievalResult> cases, FilterConfig preferences)
049    {
050        CDRSet rs = new CDRSet();
051        
052        ArrayList<CBRCase> candidates = new ArrayList<>(SelectCases.selectAll(cases));
053        while(!candidates.isEmpty())
054        {
055            CBRCase c1 = candidates.get(0);
056            rs.add(c1);
057            rs.addToLikeSet(c1, c1);
058            rs.addToCoveredSet(c1, c1);
059            candidates.remove(0);
060            for(CBRCase c2 : candidates)
061            {
062                Set<Attribute> compromises1 = getCompromises(c1,query,preferences);
063                Set<Attribute> compromises2 = getCompromises(c2,query,preferences);
064                if( compromises1.equals(compromises2))
065                    rs.addToLikeSet(c1, c2);
066                if( compromises2.containsAll(compromises1) )
067                    rs.addToCoveredSet(c1, c2);
068            }
069            candidates.removeAll(rs.getCoveredSet(c1));
070        }
071        return rs;
072    }
073    
074    /**
075     * Returns the compromises of a case
076     * @param _case to find the compromises
077     * @param query to compare
078     * @param preferences define the predicates that evaluate the user preferences
079     * @return a set of attributes
080     */
081    public static Set<Attribute> getCompromises(CBRCase _case, CBRQuery query, FilterConfig preferences)
082    {
083        Set<Attribute> compromises = new HashSet<Attribute>();
084        
085        for(Attribute at : preferences.getDefinedAttributes())
086        {
087            try
088            {
089                FilterPredicate predicate = preferences.getPredicate(at);
090                Object caseObject = AttributeUtils.findValue(at, _case.getDescription());
091                Object queryObject = AttributeUtils.findValue(at, query.getDescription());
092                if(!predicate.compute(caseObject, queryObject))
093                compromises.add(at);
094            } catch (NoApplicableFilterPredicateException e)
095            {
096                LogManager.getLogger(CompromiseDrivenSelection.class).error(e);
097            }
098        }
099        
100        return compromises;
101    }
102}