001/**
002 * FilterBasedRetrievalMethod.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 * 28/10/2007
008 */
009package es.ucm.fdi.gaia.jcolibri.method.retrieve.FilterBasedRetrieval;
010
011import java.util.ArrayList;
012import java.util.Collection;
013
014import org.apache.logging.log4j.LogManager;
015
016import es.ucm.fdi.gaia.jcolibri.cbrcore.Attribute;
017import es.ucm.fdi.gaia.jcolibri.cbrcore.CBRCase;
018import es.ucm.fdi.gaia.jcolibri.cbrcore.CBRQuery;
019import es.ucm.fdi.gaia.jcolibri.cbrcore.CaseComponent;
020import es.ucm.fdi.gaia.jcolibri.method.retrieve.FilterBasedRetrieval.predicates.FilterPredicate;
021import es.ucm.fdi.gaia.jcolibri.util.AttributeUtils;
022
023/**
024 * Retrieves cases according boolean predicates (less, more, equal, ...) over the attributes.
025 * 
026 * @author Juan A. Recio-Garcia
027 * @author Developed at University College Cork (Ireland) in collaboration with Derek Bridge.
028 * @version 1.0
029 *
030 */
031public class FilterBasedRetrievalMethod
032{
033    /**
034     * Retrieves cases that match with the given predicates in filter config
035     * @param cases to retrieve from
036     * @param query to compare
037     * @param filterConfig contains the filter predicates
038     * @return a list of cases
039     */
040    public static Collection<CBRCase> filterCases(Collection<CBRCase> cases, CBRQuery query, FilterConfig filterConfig)
041    {
042        if(filterConfig == null)
043            return cases;
044        Collection<CBRCase> res = new ArrayList<CBRCase>();
045        for(CBRCase c:cases)
046            if(filter(c.getDescription(),query.getDescription(),filterConfig))
047                res.add(c);
048        return res;
049    }
050    
051    /**
052     * Filters a case component
053     * @param cc
054     * @param qc
055     * @param config
056     * @return
057     */
058    private static boolean filter(CaseComponent cc, CaseComponent qc, FilterConfig config)
059    {
060        try
061        {
062            for(Attribute att : AttributeUtils.getAttributes(cc))
063            {
064                if(CaseComponent.class.isAssignableFrom(att.getType()))
065                {    
066                        if(!filter((CaseComponent)att.getValue(cc),(CaseComponent)att.getValue(qc),config))
067                            return false;
068                }
069                else if(att.equals(cc.getIdAttribute()))
070                        continue;
071                else
072                {
073                        FilterPredicate predicate = config.getPredicate(att);
074                        if(predicate == null)
075                            continue;
076                        if(!predicate.compute(att.getValue(cc), att.getValue(qc)))
077                            return false;
078                }
079            }
080            return true;
081        } catch (Exception e)
082        {
083            LogManager.getLogger(FilterBasedRetrievalMethod.class).error(e);
084            return false; 
085        }
086    }
087}