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.Set;
036
037import org.openimaj.ml.annotation.ScoredAnnotation;
038import org.openimaj.text.nlp.namedentity.YagoEntityCandidateFinderFactory.YagoEntityCandidateFinder;
039
040/**
041 * {@link EntityAnnotator} wrapper for a {@link YagoEntityCandidateFinder}
042 * @author Laurence Willmore (lgw1e10@ecs.soton.ac.uk)
043 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
044 */
045public class YagoEntityCandidateAnnotator
046                extends
047                EntityAnnotator {       
048        private YagoEntityCandidateFinder ycf;
049        
050        
051        /**
052         * Default Constructor
053         * @param ycf does the work of finding candidates
054         */
055        public YagoEntityCandidateAnnotator(YagoEntityCandidateFinder ycf){
056                super();
057                this.ycf=ycf;
058        }
059        
060        @Override
061        public Set<HashMap<String, Object>> getAnnotations() {
062                return null;
063        }
064
065        @Override
066        public List<ScoredAnnotation<HashMap<String, Object>>> annotate(
067                        List<String> tokens) {
068                List<ScoredAnnotation<HashMap<String, Object>>> annos = new ArrayList<ScoredAnnotation<HashMap<String,Object>>>();
069                for(List<NamedEntity> entList : ycf.getCandidates(tokens)){
070                        for(NamedEntity ent:entList){
071                                HashMap<String,Object> annotation = new HashMap<String, Object>();
072                                annotation.put(EntityAnnotator.URI, ent.rootName);
073                                annotation.put(EntityAnnotator.START_TOKEN, ent.startToken);
074                                annotation.put(EntityAnnotator.END_TOKEN, ent.stopToken);
075                                annotation.put(EntityAnnotator.TYPE, ent.type);
076                                annos.add(new ScoredAnnotation<HashMap<String,Object>>(annotation, 1));
077                        }                       
078                }
079                return annos;
080        }       
081
082}