001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.text.nlp.namedentity;
031
032import java.util.ArrayList;
033import java.util.HashMap;
034import java.util.List;
035import java.util.Map;
036import java.util.Set;
037
038import org.openimaj.ml.annotation.ScoredAnnotation;
039import org.openimaj.text.nlp.namedentity.YagoEntityContextScorerFactory.YagoEntityContextScorer;
040
041/**
042 * {@link EntityAnnotator} wrapper for {@link YagoEntityContextScorer}
043 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
044 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
045 */
046public class YagoEntityContextAnnotator
047                extends
048                EntityAnnotator {
049        
050        private YagoEntityContextScorer ywi;
051
052        /**
053         * Default Constructor
054         * @param ywi
055         */
056        public YagoEntityContextAnnotator(YagoEntityContextScorer ywi) {
057                super();
058                this.ywi = ywi;
059        }
060
061        @Override
062        public Set<HashMap<String, Object>> getAnnotations() {
063                // Intentionally blank
064                return null;
065        }
066
067        @Override
068        public List<ScoredAnnotation<HashMap<String, Object>>> annotate(
069                        List<String> object) {
070                Map<NamedEntity,Float> results = ywi.getScoredEntitiesFromContext(object);
071                ArrayList<ScoredAnnotation<HashMap<String,Object>>> ret = new ArrayList<ScoredAnnotation<HashMap<String,Object>>>();
072                for(NamedEntity entity : results.keySet()){
073                        HashMap<String,Object> annotation = new HashMap<String, Object>();
074                        annotation.put(URI, entity.rootName);
075                        annotation.put(TYPE, entity.type.toString());
076                        annotation.put(SCORE, results.get(entity));
077                        ret.add(new ScoredAnnotation<HashMap<String,Object>>(annotation,1));
078                }
079                return ret;
080        }
081
082}