001/**
002 * OntCosine.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 * 11/01/2007
008 */
009package es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.local.ontology;
010
011import java.util.ArrayList;
012import java.util.HashSet;
013import java.util.Iterator;
014import java.util.Set;
015
016import es.ucm.fdi.gaia.jcolibri.datatypes.Instance;
017import es.ucm.fdi.gaia.jcolibri.exception.NoApplicableSimilarityFunctionException;
018import es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.LocalSimilarityFunction;
019import es.ucm.fdi.gaia.jcolibri.util.FileIO;
020import es.ucm.fdi.gaia.jcolibri.util.OntoBridgeSingleton;
021import es.ucm.fdi.gaia.ontobridge.OntoBridge;
022import es.ucm.fdi.gaia.ontobridge.OntologyDocument;
023import org.apache.logging.log4j.LogManager;
024
025/**
026 * This function computes the cosine similarity. 
027 * See package documentation for details.
028 * 
029 * @author Juan A. Recio-Garcia
030 * @version 1.0
031 * @see jcolibri.method.retrieve.NNretrieval.similarity.local
032 */
033public class OntCosine implements LocalSimilarityFunction {
034
035    /* (non-Javadoc)
036     * @see jcolibri.method.retrieve.NNretrieval.similarity.LocalSimilarityFunction#compute(java.lang.Object, java.lang.Object, jcolibri.cbrcore.CaseComponent, jcolibri.cbrcore.CaseComponent, jcolibri.cbrcore.CBRCase, jcolibri.cbrcore.CBRQuery, java.lang.String)
037     */
038    public double compute(Object caseObject, Object queryObject) throws NoApplicableSimilarityFunctionException
039    {
040        if ((caseObject == null) || (queryObject == null))
041            return 0;
042        if (!(caseObject instanceof Instance))
043            throw new NoApplicableSimilarityFunctionException(this.getClass(), caseObject.getClass());
044        if (!(queryObject instanceof Instance))
045            throw new NoApplicableSimilarityFunctionException(this.getClass(), queryObject.getClass());
046
047        Instance i1 = (Instance)caseObject;
048        Instance i2 = (Instance)queryObject;
049
050        if(i1.equals(i2))
051            return 1;
052
053
054        OntoBridge ob = OntoBridgeSingleton.getOntoBridge();
055
056        Set<String> sc1 = new HashSet<String>();        
057        for(Iterator<String> iter = ob.listBelongingClasses(i1.toString());iter.hasNext(); )
058            sc1.add(iter.next());
059        sc1.remove(ob.getThingURI());
060
061        Set<String> sc2 = new HashSet<String>();        
062        for(Iterator<String> iter = ob.listBelongingClasses(i2.toString());iter.hasNext(); )
063            sc2.add(iter.next());
064        sc2.remove(ob.getThingURI());
065
066        double sc1size = sc1.size();
067        double sc2size = sc2.size();
068
069        sc1.retainAll(sc2);
070        double intersectionsize = sc1.size();
071
072        double res =  intersectionsize / (Math.sqrt(sc1size)* Math.sqrt(sc2size));
073        return res;
074    }
075
076    /** Applicable to Instance */
077    public boolean isApplicable(Object o1, Object o2)
078    {
079        if((o1==null)&&(o2==null))
080            return true;
081        else if(o1==null)
082            return o2 instanceof Instance;
083        else if(o2==null)
084            return o1 instanceof Instance;
085        else
086            return (o1 instanceof Instance)&&(o2 instanceof Instance);
087    }
088
089    /**
090     * Testing method using test5 ontology
091     */
092    public static void main(String[] args)
093    {
094        try {
095            // Obtain a reference to OntoBridge
096            OntoBridge ob = OntoBridgeSingleton.getOntoBridge();
097            // Configure it to work with the Pellet reasoner
098            ob.initWithPelletReasoner();
099            // Setup the main ontology
100            OntologyDocument mainOnto = new OntologyDocument("http://gaia.fdi.ucm.es/ontologies/vacation.owl", 
101                    FileIO.findFile("jcolibri/test/test5/vacation.owl").toExternalForm());
102            // There are not subontologies
103            ArrayList<OntologyDocument> subOntologies = new ArrayList<OntologyDocument>();
104            // Load the ontology
105            ob.loadOntology(mainOnto, subOntologies, false);
106
107            OntCosine sim = new OntCosine();
108
109            System.out.println("cosine(CAR,TRAIN)="+sim.compute(new Instance("CAR"), new Instance("TRAIN")));
110            System.out.println("cosine(CAR,IBIZA)="+sim.compute(new Instance("CAR"), new Instance("IBIZA")));
111            System.out.println("cosine(CAR,I101)="+sim.compute(new Instance("CAR"), new Instance("I101")));
112
113        }catch(Exception e)
114        {
115            LogManager.getLogger(OntDeepBasic.class).error(e);
116        }
117    }
118}